diff --git a/ansys-grantami-serverapi-openapi/pyproject.toml b/ansys-grantami-serverapi-openapi/pyproject.toml index 0319cab4f..1267beec0 100644 --- a/ansys-grantami-serverapi-openapi/pyproject.toml +++ b/ansys-grantami-serverapi-openapi/pyproject.toml @@ -1,5 +1,5 @@ [build-system] -requires = ["uv_build>=0.9.23,<0.12.0"] +requires = ["uv_build>=0.9.23,<0.11.0"] build-backend = "uv_build" [tool.uv.build-backend] @@ -8,7 +8,7 @@ module-name = "ansys.grantami.serverapi_openapi" [project] name = "ansys-grantami-serverapi-openapi" description = "Autogenerated client library for the Granta MI Server API." -version = "5.2.0.dev1077" +version = "5.2.0.dev1079" license = "MIT" requires-python = ">=3.10" authors = [ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py index 2d3fc6d39..078b489f3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py @@ -20,4 +20,4 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -__version__ = "5.2.0.dev1077" +__version__ = "5.2.0.dev1079" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/__init__.py index 720b1061b..2a51a3285 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/__init__.py @@ -32,24 +32,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git """ -from .api.access_control___attribute_based_categories_api import ( - AccessControlAttributeBasedCategoriesApi, -) -from .api.access_control___permission_based_schema_api import AccessControlPermissionBasedSchemaApi - # import apis into sdk package -from .api.access_control_api import AccessControlApi -from .api.activity_log_api import ActivityLogApi from .api.aggregation_api import AggregationApi -from .api.blob_infos_api import BlobInfosApi -from .api.blobs_api import BlobsApi from .api.bulk_api import BulkApi -from .api.currencies_api import CurrenciesApi from .api.data_api import DataApi from .api.data_export_api import DataExportApi -from .api.data_updater_api import DataUpdaterApi from .api.database_api import DatabaseApi -from .api.find_similar_api import FindSimilarApi from .api.graph_api import GraphApi from .api.help_location_api import HelpLocationApi from .api.identities_api import IdentitiesApi @@ -61,7 +49,7 @@ from .api.list_management_api import ListManagementApi from .api.list_permissions_api import ListPermissionsApi from .api.metrics_api import MetricsApi -from .api.record_links_api import RecordLinksApi +from .api.permission_based_access_control_api import PermissionBasedAccessControlApi from .api.records___record_histories_api import RecordsRecordHistoriesApi from .api.records___record_versions_api import RecordsRecordVersionsApi from .api.schema___attributes_api import SchemaAttributesApi @@ -71,7 +59,6 @@ from .api.schema___databases_api import SchemaDatabasesApi from .api.schema___discrete_types___discrete_values_api import SchemaDiscreteTypesDiscreteValuesApi from .api.schema___discrete_types_api import SchemaDiscreteTypesApi -from .api.schema___display_names_api import SchemaDisplayNamesApi from .api.schema___exporters_api import SchemaExportersApi from .api.schema___expressions_api import SchemaExpressionsApi from .api.schema___global_standard_names_api import SchemaGlobalStandardNamesApi @@ -82,20 +69,16 @@ from .api.schema___parameters_api import SchemaParametersApi from .api.schema___profile_tables_api import SchemaProfileTablesApi from .api.schema___profiles_api import SchemaProfilesApi -from .api.schema___quality_systems_api import SchemaQualitySystemsApi from .api.schema___record_link_groups_api import SchemaRecordLinkGroupsApi from .api.schema___replacement_strings_api import SchemaReplacementStringsApi -from .api.schema___search_masks_api import SchemaSearchMasksApi -from .api.schema___search_templates_api import SchemaSearchTemplatesApi -from .api.schema___security_groups_api import SchemaSecurityGroupsApi from .api.schema___standard_names_api import SchemaStandardNamesApi from .api.schema___subsets_api import SchemaSubsetsApi from .api.schema___tables_api import SchemaTablesApi -from .api.schema___unit_equivalents_api import SchemaUnitEquivalentsApi from .api.schema___units_api import SchemaUnitsApi -from .api.schema___xy_chart_templates_api import SchemaXYChartTemplatesApi from .api.schema_api import SchemaApi from .api.search_api import SearchApi +from .api.selection_searches_api import SelectionSearchesApi +from .api.server_manager_api import ServerManagerApi from .api.status_api import StatusApi from .models.attributes_attributeguidimportfile_body1 import AttributesAttributeguidimportfileBody1 @@ -117,49 +100,14 @@ from .models.granta_mi_record_property_fake_attribute_identities import ( GrantaMIRecordPropertyFakeAttributeIdentities, ) -from .models.granta_mi_search_free_text_identifiers import GrantaMISearchFreeTextIdentifiers from .models.gsa_about_attribute_cannot_be_meta_attribute_error_detail import ( GsaAboutAttributeCannotBeMetaAttributeErrorDetail, ) -from .models.gsa_access_control_categories_info import GsaAccessControlCategoriesInfo -from .models.gsa_access_control_category import GsaAccessControlCategory -from .models.gsa_access_control_category_creation_exception import ( - GsaAccessControlCategoryCreationException, -) -from .models.gsa_access_control_category_error_detail import GsaAccessControlCategoryErrorDetail -from .models.gsa_access_control_category_error_reason import GsaAccessControlCategoryErrorReason -from .models.gsa_access_control_category_include import GsaAccessControlCategoryInclude -from .models.gsa_access_control_category_no_such_entity_type import ( - GsaAccessControlCategoryNoSuchEntityType, -) -from .models.gsa_access_control_category_table_mapping import GsaAccessControlCategoryTableMapping -from .models.gsa_access_control_category_update_exception import ( - GsaAccessControlCategoryUpdateException, -) -from .models.gsa_access_control_info import GsaAccessControlInfo -from .models.gsa_access_control_mode import GsaAccessControlMode -from .models.gsa_access_control_mode_info import GsaAccessControlModeInfo -from .models.gsa_activity_log_application_name_filter import GsaActivityLogApplicationNameFilter -from .models.gsa_activity_log_application_names_collection_filter import ( - GsaActivityLogApplicationNamesCollectionFilter, -) -from .models.gsa_activity_log_collection_match_type import GsaActivityLogCollectionMatchType -from .models.gsa_activity_log_database_key_filter import GsaActivityLogDatabaseKeyFilter -from .models.gsa_activity_log_date_filter import GsaActivityLogDateFilter -from .models.gsa_activity_log_entries_filter import GsaActivityLogEntriesFilter -from .models.gsa_activity_log_entries_info import GsaActivityLogEntriesInfo -from .models.gsa_activity_log_entry import GsaActivityLogEntry -from .models.gsa_activity_log_match_type import GsaActivityLogMatchType -from .models.gsa_activity_log_usage_mode import GsaActivityLogUsageMode -from .models.gsa_activity_log_usage_mode_filter import GsaActivityLogUsageModeFilter -from .models.gsa_activity_log_username_filter import GsaActivityLogUsernameFilter from .models.gsa_add_database import GsaAddDatabase from .models.gsa_add_database_issue_type import GsaAddDatabaseIssueType -from .models.gsa_add_database_security_groups import GsaAddDatabaseSecurityGroups from .models.gsa_add_database_validation_issue import GsaAddDatabaseValidationIssue from .models.gsa_add_database_validation_result import GsaAddDatabaseValidationResult from .models.gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset -from .models.gsa_additional_sql_parameters import GsaAdditionalSqlParameters from .models.gsa_aggregation import GsaAggregation from .models.gsa_aggregation_criterion import GsaAggregationCriterion from .models.gsa_aggregation_datum import GsaAggregationDatum @@ -182,10 +130,6 @@ from .models.gsa_append_point_values import GsaAppendPointValues from .models.gsa_applicable_datum import GsaApplicableDatum from .models.gsa_applications_info import GsaApplicationsInfo -from .models.gsa_apply_options import GsaApplyOptions -from .models.gsa_association_chain_create_put_layout_item import ( - GsaAssociationChainCreatePutLayoutItem, -) from .models.gsa_attribute import GsaAttribute from .models.gsa_attribute_aggregation import GsaAttributeAggregation from .models.gsa_attribute_aggregation_criterion import GsaAttributeAggregationCriterion @@ -194,18 +138,10 @@ ) from .models.gsa_attribute_aggregation_type import GsaAttributeAggregationType from .models.gsa_attribute_aggregation_value_criterion import GsaAttributeAggregationValueCriterion -from .models.gsa_attribute_already_specified_smart_attributes_error_detail import ( - GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail, -) -from .models.gsa_attribute_based_access_control_info import GsaAttributeBasedAccessControlInfo -from .models.gsa_attribute_create_put_layout_item import GsaAttributeCreatePutLayoutItem from .models.gsa_attribute_creation_exception import GsaAttributeCreationException from .models.gsa_attribute_criterion import GsaAttributeCriterion from .models.gsa_attribute_criterion_type import GsaAttributeCriterionType from .models.gsa_attribute_deletion_exception import GsaAttributeDeletionException -from .models.gsa_attribute_discrete_type_mismatch_error_detail import ( - GsaAttributeDiscreteTypeMismatchErrorDetail, -) from .models.gsa_attribute_error_detail import GsaAttributeErrorDetail from .models.gsa_attribute_error_reason import GsaAttributeErrorReason from .models.gsa_attribute_exists_aggregation import GsaAttributeExistsAggregation @@ -217,22 +153,12 @@ from .models.gsa_attribute_matches_criterion import GsaAttributeMatchesCriterion from .models.gsa_attribute_no_such_entity_type import GsaAttributeNoSuchEntityType from .models.gsa_attribute_not_applicable_criterion import GsaAttributeNotApplicableCriterion -from .models.gsa_attribute_not_on_table_error_detail import GsaAttributeNotOnTableErrorDetail -from .models.gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail, -) -from .models.gsa_attribute_pair_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairTypeMismatchSmartAttributesErrorDetail, -) from .models.gsa_attribute_reference import GsaAttributeReference from .models.gsa_attribute_scale_type import GsaAttributeScaleType from .models.gsa_attribute_sort_criterion import GsaAttributeSortCriterion from .models.gsa_attribute_threshold_type import GsaAttributeThresholdType from .models.gsa_attribute_to_export import GsaAttributeToExport from .models.gsa_attribute_type import GsaAttributeType -from .models.gsa_attribute_type_not_supported_smart_attributes_error_detail import ( - GsaAttributeTypeNotSupportedSmartAttributesErrorDetail, -) from .models.gsa_attribute_usage_data_modification_error_detail import ( GsaAttributeUsageDataModificationErrorDetail, ) @@ -240,63 +166,33 @@ from .models.gsa_attribute_value_aggregation import GsaAttributeValueAggregation from .models.gsa_attributes_info import GsaAttributesInfo from .models.gsa_axis_name import GsaAxisName -from .models.gsa_blob_info_dto import GsaBlobInfoDto from .models.gsa_boolean_criterion import GsaBooleanCriterion from .models.gsa_boost_by_guid import GsaBoostByGuid from .models.gsa_boost_by_identity import GsaBoostByIdentity -from .models.gsa_bracket_mismatch_unit_equation_error_detail import ( - GsaBracketMismatchUnitEquationErrorDetail, -) from .models.gsa_bulk_info import GsaBulkInfo from .models.gsa_bulk_request import GsaBulkRequest from .models.gsa_bulk_request_http_method import GsaBulkRequestHttpMethod from .models.gsa_bulk_request_item import GsaBulkRequestItem from .models.gsa_bulk_response_item import GsaBulkResponseItem from .models.gsa_calendar_interval import GsaCalendarInterval -from .models.gsa_category_replace_permission_category_error_detail import ( - GsaCategoryReplacePermissionCategoryErrorDetail, -) -from .models.gsa_chart_data import GsaChartData -from .models.gsa_chart_data_type import GsaChartDataType -from .models.gsa_circular_reference_folder_move_error_detail import ( - GsaCircularReferenceFolderMoveErrorDetail, -) -from .models.gsa_code_missing_currency_error_detail import GsaCodeMissingCurrencyErrorDetail -from .models.gsa_code_whitespace_currency_error_detail import GsaCodeWhitespaceCurrencyErrorDetail -from .models.gsa_config_invalid_json_file_error_detail import GsaConfigInvalidJsonFileErrorDetail from .models.gsa_configuration import GsaConfiguration -from .models.gsa_configuration_details import GsaConfigurationDetails from .models.gsa_configurations_info import GsaConfigurationsInfo from .models.gsa_connection_details import GsaConnectionDetails from .models.gsa_constant import GsaConstant -from .models.gsa_constant_creation_exception import GsaConstantCreationException from .models.gsa_constant_deletion_exception import GsaConstantDeletionException -from .models.gsa_constant_error_detail import GsaConstantErrorDetail -from .models.gsa_constant_error_reason import GsaConstantErrorReason -from .models.gsa_constant_update_exception import GsaConstantUpdateException -from .models.gsa_constant_usage_data_modification_error_detail import ( - GsaConstantUsageDataModificationErrorDetail, -) from .models.gsa_constants_info import GsaConstantsInfo -from .models.gsa_continuous_quality_system import GsaContinuousQualitySystem from .models.gsa_continuous_range import GsaContinuousRange from .models.gsa_copy_record_history import GsaCopyRecordHistory -from .models.gsa_create_access_control_category import GsaCreateAccessControlCategory -from .models.gsa_create_access_control_category_table_mapping import ( - GsaCreateAccessControlCategoryTableMapping, -) from .models.gsa_create_attribute import GsaCreateAttribute from .models.gsa_create_attribute_link_pair import GsaCreateAttributeLinkPair from .models.gsa_create_axis_name import GsaCreateAxisName from .models.gsa_create_configuration import GsaCreateConfiguration from .models.gsa_create_constant import GsaCreateConstant from .models.gsa_create_continuous_range import GsaCreateContinuousRange -from .models.gsa_create_cross_database_link_target import GsaCreateCrossDatabaseLinkTarget from .models.gsa_create_cross_database_record_link_group import ( GsaCreateCrossDatabaseRecordLinkGroup, ) from .models.gsa_create_data_rule import GsaCreateDataRule -from .models.gsa_create_data_update_server_api_request import GsaCreateDataUpdateServerApiRequest from .models.gsa_create_date_time_attribute import GsaCreateDateTimeAttribute from .models.gsa_create_discrete_attribute import GsaCreateDiscreteAttribute from .models.gsa_create_discrete_functional_attribute import GsaCreateDiscreteFunctionalAttribute @@ -314,6 +210,7 @@ from .models.gsa_create_discrete_parameter_value import GsaCreateDiscreteParameterValue from .models.gsa_create_discrete_range import GsaCreateDiscreteRange from .models.gsa_create_discrete_type import GsaCreateDiscreteType +from .models.gsa_create_dynamic_record_link_group import GsaCreateDynamicRecordLinkGroup from .models.gsa_create_expression import GsaCreateExpression from .models.gsa_create_file_attribute import GsaCreateFileAttribute from .models.gsa_create_float_functional_attribute import GsaCreateFloatFunctionalAttribute @@ -357,49 +254,31 @@ from .models.gsa_create_parameter import GsaCreateParameter from .models.gsa_create_parameter_content import GsaCreateParameterContent from .models.gsa_create_parameter_value import GsaCreateParameterValue -from .models.gsa_create_permission import GsaCreatePermission -from .models.gsa_create_permission_category import GsaCreatePermissionCategory from .models.gsa_create_picture_attribute import GsaCreatePictureAttribute from .models.gsa_create_point_attribute import GsaCreatePointAttribute from .models.gsa_create_profile import GsaCreateProfile from .models.gsa_create_profile_table import GsaCreateProfileTable -from .models.gsa_create_put_layout_item import GsaCreatePutLayoutItem -from .models.gsa_create_put_permission import GsaCreatePutPermission -from .models.gsa_create_put_permission_category import GsaCreatePutPermissionCategory from .models.gsa_create_range_attribute import GsaCreateRangeAttribute from .models.gsa_create_record_history import GsaCreateRecordHistory from .models.gsa_create_record_link_group import GsaCreateRecordLinkGroup from .models.gsa_create_record_list import GsaCreateRecordList from .models.gsa_create_record_list_items_info import GsaCreateRecordListItemsInfo from .models.gsa_create_replacement_string import GsaCreateReplacementString +from .models.gsa_create_search_request import GsaCreateSearchRequest from .models.gsa_create_short_text_attribute import GsaCreateShortTextAttribute -from .models.gsa_create_smart_link_target import GsaCreateSmartLinkTarget -from .models.gsa_create_smart_record_link_group import GsaCreateSmartRecordLinkGroup from .models.gsa_create_standard_name import GsaCreateStandardName -from .models.gsa_create_static_link_target import GsaCreateStaticLinkTarget from .models.gsa_create_static_record_link_group import GsaCreateStaticRecordLinkGroup from .models.gsa_create_subset import GsaCreateSubset from .models.gsa_create_table import GsaCreateTable from .models.gsa_create_tabular_attribute import GsaCreateTabularAttribute from .models.gsa_create_tabular_column import GsaCreateTabularColumn from .models.gsa_create_unit import GsaCreateUnit -from .models.gsa_create_unit_mapping import GsaCreateUnitMapping from .models.gsa_create_unit_system import GsaCreateUnitSystem from .models.gsa_created_by_user_property import GsaCreatedByUserProperty from .models.gsa_created_date_property import GsaCreatedDateProperty from .models.gsa_criterion import GsaCriterion from .models.gsa_criterion_type import GsaCriterionType -from .models.gsa_cross_database_link import GsaCrossDatabaseLink -from .models.gsa_cross_database_link_create_put_layout_item import ( - GsaCrossDatabaseLinkCreatePutLayoutItem, -) -from .models.gsa_cross_database_record_link import GsaCrossDatabaseRecordLink from .models.gsa_cross_database_record_link_group import GsaCrossDatabaseRecordLinkGroup -from .models.gsa_cross_database_record_link_result import GsaCrossDatabaseRecordLinkResult -from .models.gsa_currencies_info import GsaCurrenciesInfo -from .models.gsa_currency import GsaCurrency -from .models.gsa_currency_error_detail import GsaCurrencyErrorDetail -from .models.gsa_currency_error_reason import GsaCurrencyErrorReason from .models.gsa_current_user import GsaCurrentUser from .models.gsa_data_export_applicable_datum import GsaDataExportApplicableDatum from .models.gsa_data_export_binary_data import GsaDataExportBinaryData @@ -453,29 +332,13 @@ from .models.gsa_data_modification_error_reason import GsaDataModificationErrorReason from .models.gsa_data_rule import GsaDataRule from .models.gsa_data_rules_info import GsaDataRulesInfo -from .models.gsa_data_source import GsaDataSource -from .models.gsa_data_update import GsaDataUpdate -from .models.gsa_data_update_header import GsaDataUpdateHeader -from .models.gsa_data_update_run_info import GsaDataUpdateRunInfo -from .models.gsa_data_update_token import GsaDataUpdateToken -from .models.gsa_data_updater_job import GsaDataUpdaterJob -from .models.gsa_data_updater_job_status import GsaDataUpdaterJobStatus -from .models.gsa_data_updater_job_type import GsaDataUpdaterJobType -from .models.gsa_data_updater_project import GsaDataUpdaterProject from .models.gsa_data_usage_data_modification_error_detail import ( GsaDataUsageDataModificationErrorDetail, ) from .models.gsa_database import GsaDatabase -from .models.gsa_database_currency_unit_usage_data_modification_error_detail import ( - GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail, -) -from .models.gsa_database_issues import GsaDatabaseIssues from .models.gsa_database_key_property import GsaDatabaseKeyProperty -from .models.gsa_database_security_groups import GsaDatabaseSecurityGroups -from .models.gsa_database_security_groups_info import GsaDatabaseSecurityGroupsInfo from .models.gsa_database_status import GsaDatabaseStatus from .models.gsa_database_status_information import GsaDatabaseStatusInformation -from .models.gsa_database_user_capabilities import GsaDatabaseUserCapabilities from .models.gsa_databases_info import GsaDatabasesInfo from .models.gsa_date_time_aggregation import GsaDateTimeAggregation from .models.gsa_date_time_aggregation_datum_criterion import GsaDateTimeAggregationDatumCriterion @@ -511,32 +374,15 @@ from .models.gsa_default_expression_not_found_maths_functional_error_detail import ( GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail, ) -from .models.gsa_default_fallback_security_groups import GsaDefaultFallbackSecurityGroups from .models.gsa_default_free_parameter_not_found_maths_functional_error_detail import ( GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail, ) -from .models.gsa_default_layout_guid_error_detail import GsaDefaultLayoutGuidErrorDetail -from .models.gsa_default_parameter_value_guid_parameter_error_detail import ( - GsaDefaultParameterValueGuidParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_and_guid_parameter_error_detail import ( - GsaDefaultParameterValueIndexAndGuidParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_parameter_error_detail import ( - GsaDefaultParameterValueIndexParameterErrorDetail, -) -from .models.gsa_default_parameter_value_index_without_values_parameter_error_detail import ( - GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail, -) from .models.gsa_default_parameter_value_usage_data_modification_error_detail import ( GsaDefaultParameterValueUsageDataModificationErrorDetail, ) -from .models.gsa_default_subset_guid_error_detail import GsaDefaultSubsetGuidErrorDetail from .models.gsa_delete_record_list_item import GsaDeleteRecordListItem from .models.gsa_delete_record_list_items import GsaDeleteRecordListItems -from .models.gsa_description_length_file_error_detail import GsaDescriptionLengthFileErrorDetail from .models.gsa_discrete_attribute import GsaDiscreteAttribute -from .models.gsa_discrete_chart_data import GsaDiscreteChartData from .models.gsa_discrete_datum import GsaDiscreteDatum from .models.gsa_discrete_datum_exists_criterion import GsaDiscreteDatumExistsCriterion from .models.gsa_discrete_functional_attribute import GsaDiscreteFunctionalAttribute @@ -577,7 +423,6 @@ from .models.gsa_discrete_parameter_name_constraint import GsaDiscreteParameterNameConstraint from .models.gsa_discrete_parameter_value import GsaDiscreteParameterValue from .models.gsa_discrete_parameter_value_constraint import GsaDiscreteParameterValueConstraint -from .models.gsa_discrete_quality_system import GsaDiscreteQualitySystem from .models.gsa_discrete_range import GsaDiscreteRange from .models.gsa_discrete_range_datum_criterion import GsaDiscreteRangeDatumCriterion from .models.gsa_discrete_series import GsaDiscreteSeries @@ -593,14 +438,10 @@ from .models.gsa_discrete_type import GsaDiscreteType from .models.gsa_discrete_type_deletion_exception import GsaDiscreteTypeDeletionException from .models.gsa_discrete_type_usage import GsaDiscreteTypeUsage -from .models.gsa_discrete_type_usage_type import GsaDiscreteTypeUsageType from .models.gsa_discrete_types_info import GsaDiscreteTypesInfo from .models.gsa_discrete_value import GsaDiscreteValue from .models.gsa_discrete_value_aggregate_error_reason import GsaDiscreteValueAggregateErrorReason from .models.gsa_discrete_value_aggregate_exception import GsaDiscreteValueAggregateException -from .models.gsa_discrete_value_not_in_discrete_type_error_detail import ( - GsaDiscreteValueNotInDiscreteTypeErrorDetail, -) from .models.gsa_discrete_values_create_discrete_value import GsaDiscreteValuesCreateDiscreteValue from .models.gsa_discrete_values_discrete_value import GsaDiscreteValuesDiscreteValue from .models.gsa_discrete_values_discrete_values_info import GsaDiscreteValuesDiscreteValuesInfo @@ -609,32 +450,10 @@ ) from .models.gsa_discrete_values_update_discrete_value import GsaDiscreteValuesUpdateDiscreteValue from .models.gsa_disk_status import GsaDiskStatus -from .models.gsa_display_name_empty_error_detail import GsaDisplayNameEmptyErrorDetail -from .models.gsa_display_name_language_not_provided_error_detail import ( - GsaDisplayNameLanguageNotProvidedErrorDetail, -) -from .models.gsa_display_name_language_not_supported_error_detail import ( - GsaDisplayNameLanguageNotSupportedErrorDetail, -) -from .models.gsa_display_names_import_error_detail import GsaDisplayNamesImportErrorDetail -from .models.gsa_display_names_import_error_reason import GsaDisplayNamesImportErrorReason -from .models.gsa_display_names_import_exception import GsaDisplayNamesImportException -from .models.gsa_display_names_info import GsaDisplayNamesInfo -from .models.gsa_divide_by_zero_unit_equation_error_detail import ( - GsaDivideByZeroUnitEquationErrorDetail, -) from .models.gsa_double_sorting_value import GsaDoubleSortingValue -from .models.gsa_duplicate_categories_replace_permission_category_error_detail import ( - GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail, -) -from .models.gsa_duplicate_category_guids_access_control_error_detail import ( - GsaDuplicateCategoryGuidsAccessControlErrorDetail, -) -from .models.gsa_duplicate_code_currency_error_detail import GsaDuplicateCodeCurrencyErrorDetail from .models.gsa_duplicate_database_add_database_validation_issue import ( GsaDuplicateDatabaseAddDatabaseValidationIssue, ) -from .models.gsa_duplicate_discrete_value_error_detail import GsaDuplicateDiscreteValueErrorDetail from .models.gsa_duplicate_expression_guids_maths_functional_error_detail import ( GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail, ) @@ -644,30 +463,9 @@ from .models.gsa_duplicate_key_add_database_validation_issue import ( GsaDuplicateKeyAddDatabaseValidationIssue, ) -from .models.gsa_duplicate_mapped_attribute_guids_error_detail import ( - GsaDuplicateMappedAttributeGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail import ( - GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_parameter_guids_error_detail import ( - GsaDuplicateMappedParameterGuidsErrorDetail, -) -from .models.gsa_duplicate_mapped_record_link_group_guids_error_detail import ( - GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_duplicate_name_currency_error_detail import GsaDuplicateNameCurrencyErrorDetail from .models.gsa_duplicate_parameter_guids_attribute_error_detail import ( GsaDuplicateParameterGuidsAttributeErrorDetail, ) -from .models.gsa_duplicate_permission_guids_access_control_error_detail import ( - GsaDuplicatePermissionGuidsAccessControlErrorDetail, -) -from .models.gsa_duplicate_permissions_permission_category_error_detail import ( - GsaDuplicatePermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_duplicate_symbol_unit_error_detail import GsaDuplicateSymbolUnitErrorDetail -from .models.gsa_duplicate_table_error_detail import GsaDuplicateTableErrorDetail from .models.gsa_duplicate_tabular_column_guids_error_detail import ( GsaDuplicateTabularColumnGuidsErrorDetail, ) @@ -677,20 +475,17 @@ from .models.gsa_duplicate_version_guid_add_database_validation_issue import ( GsaDuplicateVersionGuidAddDatabaseValidationIssue, ) +from .models.gsa_dynamic_link_group_usage_data_modification_error_detail import ( + GsaDynamicLinkGroupUsageDataModificationErrorDetail, +) +from .models.gsa_dynamic_record_link_group import GsaDynamicRecordLinkGroup from .models.gsa_empty_axis_name_attribute_error_detail import GsaEmptyAxisNameAttributeErrorDetail -from .models.gsa_empty_symbol_unit_error_detail import GsaEmptySymbolUnitErrorDetail -from .models.gsa_empty_table_type_error_detail import GsaEmptyTableTypeErrorDetail from .models.gsa_enabled_licenses_info import GsaEnabledLicensesInfo from .models.gsa_entity_already_exists_error_detail import GsaEntityAlreadyExistsErrorDetail from .models.gsa_entity_identifier_already_specified_error_detail import ( GsaEntityIdentifierAlreadySpecifiedErrorDetail, ) -from .models.gsa_entity_type import GsaEntityType -from .models.gsa_equation_unit_error_detail import GsaEquationUnitErrorDetail -from .models.gsa_error_code import GsaErrorCode from .models.gsa_error_detail import GsaErrorDetail -from .models.gsa_error_response import GsaErrorResponse -from .models.gsa_exception_information import GsaExceptionInformation from .models.gsa_exclude_values_specifier import GsaExcludeValuesSpecifier from .models.gsa_existing_tabular_column_guid_error_detail import ( GsaExistingTabularColumnGuidErrorDetail, @@ -709,30 +504,14 @@ GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail, ) from .models.gsa_expressions_info import GsaExpressionsInfo -from .models.gsa_file_already_exists_file_move_error_detail import ( - GsaFileAlreadyExistsFileMoveErrorDetail, -) from .models.gsa_file_attribute import GsaFileAttribute -from .models.gsa_file_creation_exception import GsaFileCreationException from .models.gsa_file_datum import GsaFileDatum from .models.gsa_file_datum_criterion import GsaFileDatumCriterion from .models.gsa_file_datum_exists_criterion import GsaFileDatumExistsCriterion -from .models.gsa_file_error_detail import GsaFileErrorDetail -from .models.gsa_file_error_reason import GsaFileErrorReason from .models.gsa_file_header import GsaFileHeader -from .models.gsa_file_header_info import GsaFileHeaderInfo -from .models.gsa_file_move_error_detail import GsaFileMoveErrorDetail -from .models.gsa_file_move_error_reason import GsaFileMoveErrorReason -from .models.gsa_file_move_exception import GsaFileMoveException -from .models.gsa_file_name_file_error_detail import GsaFileNameFileErrorDetail -from .models.gsa_file_name_folder_error_detail import GsaFileNameFolderErrorDetail from .models.gsa_file_prefix_datum_criterion import GsaFilePrefixDatumCriterion -from .models.gsa_file_update_exception import GsaFileUpdateException from .models.gsa_files_info import GsaFilesInfo -from .models.gsa_find_similar_request import GsaFindSimilarRequest -from .models.gsa_find_similar_response import GsaFindSimilarResponse -from .models.gsa_find_similar_result import GsaFindSimilarResult -from .models.gsa_find_similar_search_criterion import GsaFindSimilarSearchCriterion +from .models.gsa_find_search_request import GsaFindSearchRequest from .models.gsa_find_standard_names import GsaFindStandardNames from .models.gsa_float_functional_aggregation import GsaFloatFunctionalAggregation from .models.gsa_float_functional_aggregation_datum_criterion import ( @@ -766,24 +545,7 @@ from .models.gsa_float_series_graph import GsaFloatSeriesGraph from .models.gsa_float_series_point import GsaFloatSeriesPoint from .models.gsa_folder import GsaFolder -from .models.gsa_folder_already_exists_folder_move_error_detail import ( - GsaFolderAlreadyExistsFolderMoveErrorDetail, -) -from .models.gsa_folder_creation_exception import GsaFolderCreationException -from .models.gsa_folder_deletion_error_detail import GsaFolderDeletionErrorDetail -from .models.gsa_folder_deletion_error_reason import GsaFolderDeletionErrorReason -from .models.gsa_folder_deletion_exception import GsaFolderDeletionException -from .models.gsa_folder_error_detail import GsaFolderErrorDetail -from .models.gsa_folder_error_reason import GsaFolderErrorReason -from .models.gsa_folder_move_error_detail import GsaFolderMoveErrorDetail -from .models.gsa_folder_move_error_reason import GsaFolderMoveErrorReason -from .models.gsa_folder_move_exception import GsaFolderMoveException -from .models.gsa_folder_type import GsaFolderType -from .models.gsa_folder_update_exception import GsaFolderUpdateException from .models.gsa_folders_info import GsaFoldersInfo -from .models.gsa_forbid_orphans_record_link_group_error_detail import ( - GsaForbidOrphansRecordLinkGroupErrorDetail, -) from .models.gsa_free_text_aggregation import GsaFreeTextAggregation from .models.gsa_free_text_aggregation_criterion import GsaFreeTextAggregationCriterion from .models.gsa_free_text_criterion import GsaFreeTextCriterion @@ -791,13 +553,9 @@ from .models.gsa_full_layout_section import GsaFullLayoutSection from .models.gsa_full_name_property import GsaFullNameProperty from .models.gsa_func_no_params_attribute_error_detail import GsaFuncNoParamsAttributeErrorDetail -from .models.gsa_functional_data_default_usage_data_modification_error_detail import ( - GsaFunctionalDataDefaultUsageDataModificationErrorDetail, -) from .models.gsa_functional_datum_parameter_info import GsaFunctionalDatumParameterInfo from .models.gsa_functional_parameter_setting import GsaFunctionalParameterSetting from .models.gsa_functional_type import GsaFunctionalType -from .models.gsa_general_unit_equation_error_detail import GsaGeneralUnitEquationErrorDetail from .models.gsa_generated_integration_schema_of_object_identifier import ( GsaGeneratedIntegrationSchemaOfObjectIdentifier, ) @@ -807,7 +565,6 @@ GsaGetModifiableRecordVersionControlException, ) from .models.gsa_get_unit_conversions_request import GsaGetUnitConversionsRequest -from .models.gsa_get_unit_equivalents_exception import GsaGetUnitEquivalentsException from .models.gsa_graph import GsaGraph from .models.gsa_graph_decoration_type import GsaGraphDecorationType from .models.gsa_graph_evaluation_settings import GsaGraphEvaluationSettings @@ -816,7 +573,6 @@ from .models.gsa_graph_type import GsaGraphType from .models.gsa_graph_value import GsaGraphValue from .models.gsa_graph_value_type import GsaGraphValueType -from .models.gsa_grid import GsaGrid from .models.gsa_grid_graph import GsaGridGraph from .models.gsa_guid_only_attribute import GsaGuidOnlyAttribute from .models.gsa_guid_only_discrete_type import GsaGuidOnlyDiscreteType @@ -827,7 +583,6 @@ from .models.gsa_guid_only_layout import GsaGuidOnlyLayout from .models.gsa_guid_only_mapping_of_object_identifier import GsaGuidOnlyMappingOfObjectIdentifier from .models.gsa_guid_only_source_of_object_identifier import GsaGuidOnlySourceOfObjectIdentifier -from .models.gsa_help_paths_validation_response import GsaHelpPathsValidationResponse from .models.gsa_histogram import GsaHistogram from .models.gsa_histogram_bucket import GsaHistogramBucket from .models.gsa_hyperlink_attribute import GsaHyperlinkAttribute @@ -836,17 +591,12 @@ from .models.gsa_hyperlink_datum_exists_criterion import GsaHyperlinkDatumExistsCriterion from .models.gsa_hyperlink_prefix_datum_criterion import GsaHyperlinkPrefixDatumCriterion from .models.gsa_hyperlink_target import GsaHyperlinkTarget -from .models.gsa_in_use_parameter_value_error_detail import GsaInUseParameterValueErrorDetail -from .models.gsa_inclusiveness import GsaInclusiveness -from .models.gsa_incompatible_units_error_detail import GsaIncompatibleUnitsErrorDetail from .models.gsa_index_record_failure import GsaIndexRecordFailure from .models.gsa_indirect_links import GsaIndirectLinks -from .models.gsa_input_connection_details import GsaInputConnectionDetails from .models.gsa_input_validation_error_detail import GsaInputValidationErrorDetail from .models.gsa_integer_aggregation import GsaIntegerAggregation from .models.gsa_integer_aggregation_datum_criterion import GsaIntegerAggregationDatumCriterion from .models.gsa_integer_attribute import GsaIntegerAttribute -from .models.gsa_integer_chart_data import GsaIntegerChartData from .models.gsa_integer_datum import GsaIntegerDatum from .models.gsa_integer_datum_criterion import GsaIntegerDatumCriterion from .models.gsa_integer_datum_exists_criterion import GsaIntegerDatumExistsCriterion @@ -869,12 +619,6 @@ GsaIntegrationSchemaOfObjectIdentifier, ) from .models.gsa_integration_schema_status import GsaIntegrationSchemaStatus -from .models.gsa_invalid_equivalence_target_error_detail import ( - GsaInvalidEquivalenceTargetErrorDetail, -) -from .models.gsa_invalid_exchange_rate_currency_error_detail import ( - GsaInvalidExchangeRateCurrencyErrorDetail, -) from .models.gsa_invalid_key_add_database_validation_issue import ( GsaInvalidKeyAddDatabaseValidationIssue, ) @@ -896,7 +640,6 @@ from .models.gsa_layout_sections_info import GsaLayoutSectionsInfo from .models.gsa_layout_tabular_column import GsaLayoutTabularColumn from .models.gsa_layouts_info import GsaLayoutsInfo -from .models.gsa_link import GsaLink from .models.gsa_link_aggregation import GsaLinkAggregation from .models.gsa_link_aggregation_datum_criterion import GsaLinkAggregationDatumCriterion from .models.gsa_link_attribute_to_export import GsaLinkAttributeToExport @@ -953,13 +696,9 @@ from .models.gsa_local_range_tabular_column import GsaLocalRangeTabularColumn from .models.gsa_local_rows_behavior import GsaLocalRowsBehavior from .models.gsa_local_short_text_tabular_column import GsaLocalShortTextTabularColumn -from .models.gsa_log_scale_negative_parameter_value_error_detail import ( - GsaLogScaleNegativeParameterValueErrorDetail, -) from .models.gsa_logical_aggregation import GsaLogicalAggregation from .models.gsa_logical_aggregation_datum_criterion import GsaLogicalAggregationDatumCriterion from .models.gsa_logical_attribute import GsaLogicalAttribute -from .models.gsa_logical_chart_data import GsaLogicalChartData from .models.gsa_logical_datum import GsaLogicalDatum from .models.gsa_logical_datum_criterion import GsaLogicalDatumCriterion from .models.gsa_logical_datum_exists_criterion import GsaLogicalDatumExistsCriterion @@ -969,11 +708,7 @@ from .models.gsa_long_text_datum_criterion import GsaLongTextDatumCriterion from .models.gsa_long_text_datum_exists_criterion import GsaLongTextDatumExistsCriterion from .models.gsa_long_text_prefix_datum_criterion import GsaLongTextPrefixDatumCriterion -from .models.gsa_many_to_many_forbid_orphans_record_link_group_error_detail import ( - GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail, -) from .models.gsa_mapping_of_object_identifier import GsaMappingOfObjectIdentifier -from .models.gsa_match_mode import GsaMatchMode from .models.gsa_maths_content import GsaMathsContent from .models.gsa_maths_functional_attribute import GsaMathsFunctionalAttribute from .models.gsa_maths_functional_attribute_error_detail import ( @@ -985,12 +720,6 @@ ) from .models.gsa_maths_functional_error_detail import GsaMathsFunctionalErrorDetail from .models.gsa_maths_functional_error_reason import GsaMathsFunctionalErrorReason -from .models.gsa_max_permissions_reached_permission_error_detail import ( - GsaMaxPermissionsReachedPermissionErrorDetail, -) -from .models.gsa_meta_attribute_cannot_have_meta_attribute_error_detail import ( - GsaMetaAttributeCannotHaveMetaAttributeErrorDetail, -) from .models.gsa_mfa_expression_error_detail import GsaMfaExpressionErrorDetail from .models.gsa_mfa_expression_error_reason import GsaMfaExpressionErrorReason from .models.gsa_mi_version import GsaMiVersion @@ -1003,46 +732,12 @@ from .models.gsa_move_file import GsaMoveFile from .models.gsa_move_folder import GsaMoveFolder from .models.gsa_move_record_history import GsaMoveRecordHistory -from .models.gsa_multi_valued_point_data_usage_data_modification_error_detail import ( - GsaMultiValuedPointDataUsageDataModificationErrorDetail, -) -from .models.gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail import ( - GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail, -) -from .models.gsa_name_already_exists_as_reverse_record_link_group_error_detail import ( - GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail, -) from .models.gsa_name_already_exists_error_detail import GsaNameAlreadyExistsErrorDetail -from .models.gsa_name_already_specified_error_detail import GsaNameAlreadySpecifiedErrorDetail -from .models.gsa_name_missing_currency_error_detail import GsaNameMissingCurrencyErrorDetail from .models.gsa_name_not_provided_error_detail import GsaNameNotProvidedErrorDetail -from .models.gsa_name_same_as_reverse_name_record_link_group_error_detail import ( - GsaNameSameAsReverseNameRecordLinkGroupErrorDetail, -) -from .models.gsa_name_whitespace_currency_error_detail import GsaNameWhitespaceCurrencyErrorDetail -from .models.gsa_name_whitespace_parameter_value_error_detail import ( - GsaNameWhitespaceParameterValueErrorDetail, -) from .models.gsa_named_criterion import GsaNamedCriterion -from .models.gsa_named_entity_access_control_category_error_detail import ( - GsaNamedEntityAccessControlCategoryErrorDetail, -) from .models.gsa_named_entity_attribute_error_detail import GsaNamedEntityAttributeErrorDetail -from .models.gsa_named_entity_constant_error_detail import GsaNamedEntityConstantErrorDetail from .models.gsa_named_entity_error_detail import GsaNamedEntityErrorDetail from .models.gsa_named_entity_error_reason import GsaNamedEntityErrorReason -from .models.gsa_named_entity_file_error_detail import GsaNamedEntityFileErrorDetail -from .models.gsa_named_entity_folder_error_detail import GsaNamedEntityFolderErrorDetail -from .models.gsa_named_entity_parameter_error_detail import GsaNamedEntityParameterErrorDetail -from .models.gsa_named_entity_parameter_value_error_detail import ( - GsaNamedEntityParameterValueErrorDetail, -) -from .models.gsa_named_entity_permission_error_detail import GsaNamedEntityPermissionErrorDetail -from .models.gsa_named_entity_record_link_group_error_detail import ( - GsaNamedEntityRecordLinkGroupErrorDetail, -) -from .models.gsa_named_entity_table_error_detail import GsaNamedEntityTableErrorDetail -from .models.gsa_named_entity_unit_error_detail import GsaNamedEntityUnitErrorDetail from .models.gsa_new_layout_association_chain_item import GsaNewLayoutAssociationChainItem from .models.gsa_new_layout_association_chain_link import GsaNewLayoutAssociationChainLink from .models.gsa_new_layout_attribute_item import GsaNewLayoutAttributeItem @@ -1051,32 +746,9 @@ from .models.gsa_new_layout_item_type import GsaNewLayoutItemType from .models.gsa_new_layout_record_link_item import GsaNewLayoutRecordLinkItem from .models.gsa_new_layout_smart_link_item import GsaNewLayoutSmartLinkItem -from .models.gsa_no_attribute_pairs_smart_attributes_error_detail import ( - GsaNoAttributePairsSmartAttributesErrorDetail, -) -from .models.gsa_no_data_file_error_detail import GsaNoDataFileErrorDetail from .models.gsa_no_expressions_maths_functional_error_detail import ( GsaNoExpressionsMathsFunctionalErrorDetail, ) -from .models.gsa_no_file_file_error_detail import GsaNoFileFileErrorDetail -from .models.gsa_no_parameter_values_parameter_error_detail import ( - GsaNoParameterValuesParameterErrorDetail, -) -from .models.gsa_no_permissions_permission_category_error_detail import ( - GsaNoPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_no_such_attribute_smart_attributes_error_detail import ( - GsaNoSuchAttributeSmartAttributesErrorDetail, -) -from .models.gsa_no_such_categories_replace_permission_category_error_detail import ( - GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail, -) -from .models.gsa_no_such_category_access_control_error_detail import ( - GsaNoSuchCategoryAccessControlErrorDetail, -) -from .models.gsa_no_such_entity_access_control_category_error_detail import ( - GsaNoSuchEntityAccessControlCategoryErrorDetail, -) from .models.gsa_no_such_entity_attribute_error_detail import GsaNoSuchEntityAttributeErrorDetail from .models.gsa_no_such_entity_tabular_column_error_detail import ( GsaNoSuchEntityTabularColumnErrorDetail, @@ -1084,56 +756,21 @@ from .models.gsa_no_such_expressions_maths_functional_error_detail import ( GsaNoSuchExpressionsMathsFunctionalErrorDetail, ) -from .models.gsa_no_such_new_parent_file_move_error_detail import ( - GsaNoSuchNewParentFileMoveErrorDetail, -) -from .models.gsa_no_such_new_parent_folder_move_error_detail import ( - GsaNoSuchNewParentFolderMoveErrorDetail, -) from .models.gsa_no_such_parameter_value_parameter_content_error_detail import ( GsaNoSuchParameterValueParameterContentErrorDetail, ) -from .models.gsa_no_such_permission_access_control_error_detail import ( - GsaNoSuchPermissionAccessControlErrorDetail, -) -from .models.gsa_no_such_permissions_permission_category_error_detail import ( - GsaNoSuchPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_no_such_target_table_record_link_group_error_detail import ( - GsaNoSuchTargetTableRecordLinkGroupErrorDetail, -) -from .models.gsa_no_such_unit_constant_error_detail import GsaNoSuchUnitConstantErrorDetail -from .models.gsa_no_such_unit_parameter_error_detail import GsaNoSuchUnitParameterErrorDetail -from .models.gsa_no_such_unit_system_unit_equivalent_error_detail import ( - GsaNoSuchUnitSystemUnitEquivalentErrorDetail, -) -from .models.gsa_no_such_unit_unit_equivalent_error_detail import ( - GsaNoSuchUnitUnitEquivalentErrorDetail, -) from .models.gsa_no_value_exists_graph_value import GsaNoValueExistsGraphValue from .models.gsa_no_values_specifier import GsaNoValuesSpecifier -from .models.gsa_non_custom_standard_name_cannot_be_changed_error_detail import ( - GsaNonCustomStandardNameCannotBeChangedErrorDetail, -) from .models.gsa_not_applicable_datum import GsaNotApplicableDatum from .models.gsa_not_the_latest_version_error_detail import GsaNotTheLatestVersionErrorDetail from .models.gsa_not_versioned_error_detail import GsaNotVersionedErrorDetail -from .models.gsa_number_parsing_unit_equation_error_detail import ( - GsaNumberParsingUnitEquationErrorDetail, -) from .models.gsa_numeric_graph_parameter_value import GsaNumericGraphParameterValue from .models.gsa_numeric_parameter import GsaNumericParameter from .models.gsa_numeric_parameter_constraint import GsaNumericParameterConstraint from .models.gsa_numeric_parameter_content import GsaNumericParameterContent from .models.gsa_numeric_parameter_data_value import GsaNumericParameterDataValue from .models.gsa_numeric_parameter_value import GsaNumericParameterValue -from .models.gsa_numeric_restricted_interpolation_parameter_error_detail import ( - GsaNumericRestrictedInterpolationParameterErrorDetail, -) from .models.gsa_object_identifier import GsaObjectIdentifier -from .models.gsa_paginated_item_type import GsaPaginatedItemType -from .models.gsa_paginated_response_of import GsaPaginatedResponseOf -from .models.gsa_pagination_links import GsaPaginationLinks from .models.gsa_paging_options import GsaPagingOptions from .models.gsa_parameter import GsaParameter from .models.gsa_parameter_constraint import GsaParameterConstraint @@ -1151,11 +788,8 @@ from .models.gsa_parameter_content_unknown_parameters_maths_functional_error_detail import ( GsaParameterContentUnknownParametersMathsFunctionalErrorDetail, ) -from .models.gsa_parameter_creation_exception import GsaParameterCreationException from .models.gsa_parameter_data_value import GsaParameterDataValue from .models.gsa_parameter_deletion_exception import GsaParameterDeletionException -from .models.gsa_parameter_error_detail import GsaParameterErrorDetail -from .models.gsa_parameter_error_reason import GsaParameterErrorReason from .models.gsa_parameter_info import GsaParameterInfo from .models.gsa_parameter_info_interpolation_type import GsaParameterInfoInterpolationType from .models.gsa_parameter_info_parameter_type import GsaParameterInfoParameterType @@ -1167,60 +801,14 @@ from .models.gsa_parameter_type_parameter_content_error_detail import ( GsaParameterTypeParameterContentErrorDetail, ) -from .models.gsa_parameter_type_parameter_error_detail import GsaParameterTypeParameterErrorDetail -from .models.gsa_parameter_update_exception import GsaParameterUpdateException -from .models.gsa_parameter_usage_data_modification_error_detail import ( - GsaParameterUsageDataModificationErrorDetail, -) from .models.gsa_parameter_value import GsaParameterValue -from .models.gsa_parameter_value_creation_exception import GsaParameterValueCreationException from .models.gsa_parameter_value_deletion_exception import GsaParameterValueDeletionException -from .models.gsa_parameter_value_error_detail import GsaParameterValueErrorDetail -from .models.gsa_parameter_value_error_reason import GsaParameterValueErrorReason -from .models.gsa_parameter_value_parameter_error_detail import GsaParameterValueParameterErrorDetail from .models.gsa_parameter_value_type import GsaParameterValueType -from .models.gsa_parameter_value_type_parameter_value_error_detail import ( - GsaParameterValueTypeParameterValueErrorDetail, -) -from .models.gsa_parameter_value_update_exception import GsaParameterValueUpdateException -from .models.gsa_parameter_value_used_by_type import GsaParameterValueUsedByType from .models.gsa_parameter_with_data_value import GsaParameterWithDataValue from .models.gsa_parameters_info import GsaParametersInfo from .models.gsa_permission import GsaPermission -from .models.gsa_permission_access_control import GsaPermissionAccessControl -from .models.gsa_permission_based_access_control_info import GsaPermissionBasedAccessControlInfo -from .models.gsa_permission_categories_access_control_error_detail import ( - GsaPermissionCategoriesAccessControlErrorDetail, -) -from .models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) -from .models.gsa_permission_categories_access_control_update_exception import ( - GsaPermissionCategoriesAccessControlUpdateException, -) from .models.gsa_permission_categories_info import GsaPermissionCategoriesInfo from .models.gsa_permission_category import GsaPermissionCategory -from .models.gsa_permission_category_access_control import GsaPermissionCategoryAccessControl -from .models.gsa_permission_category_access_control_info import ( - GsaPermissionCategoryAccessControlInfo, -) -from .models.gsa_permission_category_creation_exception import ( - GsaPermissionCategoryCreationException, -) -from .models.gsa_permission_category_error_detail import GsaPermissionCategoryErrorDetail -from .models.gsa_permission_category_error_reason import GsaPermissionCategoryErrorReason -from .models.gsa_permission_category_replace_exception import GsaPermissionCategoryReplaceException -from .models.gsa_permission_category_update_exception import GsaPermissionCategoryUpdateException -from .models.gsa_permission_creation_exception import GsaPermissionCreationException -from .models.gsa_permission_deletion_error_detail import GsaPermissionDeletionErrorDetail -from .models.gsa_permission_deletion_error_reason import GsaPermissionDeletionErrorReason -from .models.gsa_permission_deletion_exception import GsaPermissionDeletionException -from .models.gsa_permission_error_detail import GsaPermissionErrorDetail -from .models.gsa_permission_error_reason import GsaPermissionErrorReason -from .models.gsa_permission_permission_category_error_detail import ( - GsaPermissionPermissionCategoryErrorDetail, -) -from .models.gsa_permission_update_exception import GsaPermissionUpdateException from .models.gsa_permissions_info import GsaPermissionsInfo from .models.gsa_picture_attribute import GsaPictureAttribute from .models.gsa_picture_datum import GsaPictureDatum @@ -1229,7 +817,6 @@ from .models.gsa_point_aggregation import GsaPointAggregation from .models.gsa_point_aggregation_datum_criterion import GsaPointAggregationDatumCriterion from .models.gsa_point_attribute import GsaPointAttribute -from .models.gsa_point_chart_data import GsaPointChartData from .models.gsa_point_data_value import GsaPointDataValue from .models.gsa_point_datum import GsaPointDatum from .models.gsa_point_datum_criterion import GsaPointDatumCriterion @@ -1249,15 +836,6 @@ from .models.gsa_profile_table import GsaProfileTable from .models.gsa_profile_tables_info import GsaProfileTablesInfo from .models.gsa_property import GsaProperty -from .models.gsa_put_layout_item import GsaPutLayoutItem -from .models.gsa_put_permission import GsaPutPermission -from .models.gsa_put_permission_category import GsaPutPermissionCategory -from .models.gsa_put_type import GsaPutType -from .models.gsa_quality_discrete_value import GsaQualityDiscreteValue -from .models.gsa_quality_system import GsaQualitySystem -from .models.gsa_quality_system_guid_error_detail import GsaQualitySystemGuidErrorDetail -from .models.gsa_quality_system_type import GsaQualitySystemType -from .models.gsa_quality_systems_info import GsaQualitySystemsInfo from .models.gsa_query_attribute import GsaQueryAttribute from .models.gsa_query_attribute_filter import GsaQueryAttributeFilter from .models.gsa_query_attribute_info import GsaQueryAttributeInfo @@ -1274,25 +852,9 @@ from .models.gsa_query_discrete_type_properties import GsaQueryDiscreteTypeProperties from .models.gsa_query_discrete_types_info import GsaQueryDiscreteTypesInfo from .models.gsa_query_discrete_types_request import GsaQueryDiscreteTypesRequest -from .models.gsa_query_layout import GsaQueryLayout -from .models.gsa_query_layout_filter import GsaQueryLayoutFilter -from .models.gsa_query_layout_item import GsaQueryLayoutItem -from .models.gsa_query_layout_item_filter import GsaQueryLayoutItemFilter -from .models.gsa_query_layout_item_properties import GsaQueryLayoutItemProperties -from .models.gsa_query_layout_properties import GsaQueryLayoutProperties -from .models.gsa_query_layout_section import GsaQueryLayoutSection -from .models.gsa_query_layout_section_filter import GsaQueryLayoutSectionFilter -from .models.gsa_query_layout_section_properties import GsaQueryLayoutSectionProperties -from .models.gsa_query_layout_sections_info import GsaQueryLayoutSectionsInfo -from .models.gsa_query_layout_sections_request import GsaQueryLayoutSectionsRequest -from .models.gsa_query_layouts_info import GsaQueryLayoutsInfo -from .models.gsa_query_layouts_request import GsaQueryLayoutsRequest from .models.gsa_query_slim_discrete_type import GsaQuerySlimDiscreteType from .models.gsa_query_slim_discrete_type_properties import GsaQuerySlimDiscreteTypeProperties -from .models.gsa_query_slim_entity import GsaQuerySlimEntity -from .models.gsa_query_slim_entity_properties import GsaQuerySlimEntityProperties from .models.gsa_query_slim_named_entity import GsaQuerySlimNamedEntity -from .models.gsa_query_slim_named_entity_filter import GsaQuerySlimNamedEntityFilter from .models.gsa_query_slim_named_entity_properties import GsaQuerySlimNamedEntityProperties from .models.gsa_query_slim_typed_attribute import GsaQuerySlimTypedAttribute from .models.gsa_query_slim_typed_attribute_properties import GsaQuerySlimTypedAttributeProperties @@ -1305,18 +867,14 @@ from .models.gsa_query_tabular_attribute_target_properties import ( GsaQueryTabularAttributeTargetProperties, ) -from .models.gsa_query_tabular_column import GsaQueryTabularColumn -from .models.gsa_query_tabular_column_properties import GsaQueryTabularColumnProperties from .models.gsa_query_unit import GsaQueryUnit from .models.gsa_query_unit_properties import GsaQueryUnitProperties from .models.gsa_range_aggregation import GsaRangeAggregation from .models.gsa_range_aggregation_datum_criterion import GsaRangeAggregationDatumCriterion from .models.gsa_range_attribute import GsaRangeAttribute -from .models.gsa_range_chart_data import GsaRangeChartData from .models.gsa_range_datum import GsaRangeDatum from .models.gsa_range_datum_criterion import GsaRangeDatumCriterion from .models.gsa_range_datum_exists_criterion import GsaRangeDatumExistsCriterion -from .models.gsa_range_endpoint import GsaRangeEndpoint from .models.gsa_range_fixed_width_histogram_aggregation_datum_criterion import ( GsaRangeFixedWidthHistogramAggregationDatumCriterion, ) @@ -1327,7 +885,7 @@ ) from .models.gsa_record_ancestor_criterion import GsaRecordAncestorCriterion from .models.gsa_record_ancestor_history_criterion import GsaRecordAncestorHistoryCriterion -from .models.gsa_record_and_attribute_selection_type import GsaRecordAndAttributeSelectionType +from .models.gsa_record_capabilities import GsaRecordCapabilities from .models.gsa_record_color import GsaRecordColor from .models.gsa_record_color_property import GsaRecordColorProperty from .models.gsa_record_export_failure import GsaRecordExportFailure @@ -1337,18 +895,9 @@ from .models.gsa_record_history_guid_property import GsaRecordHistoryGuidProperty from .models.gsa_record_history_move_exception import GsaRecordHistoryMoveException from .models.gsa_record_history_reference import GsaRecordHistoryReference -from .models.gsa_record_link import GsaRecordLink -from .models.gsa_record_link_base import GsaRecordLinkBase -from .models.gsa_record_link_create_put_layout_item import GsaRecordLinkCreatePutLayoutItem from .models.gsa_record_link_group import GsaRecordLinkGroup -from .models.gsa_record_link_group_creation_exception import GsaRecordLinkGroupCreationException -from .models.gsa_record_link_group_error_detail import GsaRecordLinkGroupErrorDetail -from .models.gsa_record_link_group_error_reason import GsaRecordLinkGroupErrorReason from .models.gsa_record_link_group_type import GsaRecordLinkGroupType -from .models.gsa_record_link_group_update_exception import GsaRecordLinkGroupUpdateException from .models.gsa_record_link_groups_info import GsaRecordLinkGroupsInfo -from .models.gsa_record_link_result import GsaRecordLinkResult -from .models.gsa_record_link_results import GsaRecordLinkResults from .models.gsa_record_list_header import GsaRecordListHeader from .models.gsa_record_list_headers_info import GsaRecordListHeadersInfo from .models.gsa_record_list_items_info import GsaRecordListItemsInfo @@ -1368,18 +917,12 @@ from .models.gsa_record_reference_type import GsaRecordReferenceType from .models.gsa_record_subset_criterion import GsaRecordSubsetCriterion from .models.gsa_record_type import GsaRecordType -from .models.gsa_record_type_criterion import GsaRecordTypeCriterion from .models.gsa_record_type_property import GsaRecordTypeProperty -from .models.gsa_record_user_capabilities import GsaRecordUserCapabilities from .models.gsa_record_version import GsaRecordVersion from .models.gsa_record_version_reference import GsaRecordVersionReference from .models.gsa_record_with_data import GsaRecordWithData from .models.gsa_referenced_by_type import GsaReferencedByType from .models.gsa_referential_integrity_model import GsaReferentialIntegrityModel -from .models.gsa_referential_integrity_model_record_link_group_error_detail import ( - GsaReferentialIntegrityModelRecordLinkGroupErrorDetail, -) -from .models.gsa_register_update_request import GsaRegisterUpdateRequest from .models.gsa_release_record_version_control_exception import ( GsaReleaseRecordVersionControlException, ) @@ -1390,49 +933,18 @@ from .models.gsa_relevance_sort_criterion import GsaRelevanceSortCriterion from .models.gsa_remove_record_history_from_subset import GsaRemoveRecordHistoryFromSubset from .models.gsa_reorder_sections_info import GsaReorderSectionsInfo -from .models.gsa_replace_permission_categories_request import GsaReplacePermissionCategoriesRequest -from .models.gsa_replace_permission_category_error_detail import ( - GsaReplacePermissionCategoryErrorDetail, -) -from .models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) from .models.gsa_replacement_string import GsaReplacementString from .models.gsa_replacement_strings_info import GsaReplacementStringsInfo -from .models.gsa_resolve_link_targets_info import GsaResolveLinkTargetsInfo -from .models.gsa_resolve_link_targets_request import GsaResolveLinkTargetsRequest +from .models.gsa_resolved_link import GsaResolvedLink +from .models.gsa_resolved_link_info import GsaResolvedLinkInfo from .models.gsa_resolved_link_target import GsaResolvedLinkTarget -from .models.gsa_resolved_target_attribute import GsaResolvedTargetAttribute from .models.gsa_response_options import GsaResponseOptions from .models.gsa_resubmit_job_request import GsaResubmitJobRequest -from .models.gsa_retarget_potential_request import GsaRetargetPotentialRequest -from .models.gsa_retarget_request import GsaRetargetRequest -from .models.gsa_retarget_result import GsaRetargetResult -from .models.gsa_retarget_result_type import GsaRetargetResultType -from .models.gsa_retarget_results_info import GsaRetargetResultsInfo -from .models.gsa_reverse_name_already_exists_as_name_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail, -) -from .models.gsa_reverse_name_already_exists_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail, -) -from .models.gsa_reverse_name_not_provided_record_link_group_error_detail import ( - GsaReverseNameNotProvidedRecordLinkGroupErrorDetail, -) from .models.gsa_rich_text_type import GsaRichTextType from .models.gsa_rich_text_value import GsaRichTextValue -from .models.gsa_role_not_provided_permission_error_detail import ( - GsaRoleNotProvidedPermissionErrorDetail, -) from .models.gsa_rollup_export_failure import GsaRollupExportFailure from .models.gsa_rollup_reference import GsaRollupReference -from .models.gsa_root_folder_move_error_detail import GsaRootFolderMoveErrorDetail -from .models.gsa_root_record_not_available_to_rename_error_detail import ( - GsaRootRecordNotAvailableToRenameErrorDetail, -) -from .models.gsa_rule_engine import GsaRuleEngine -from .models.gsa_same_parent_file_move_error_detail import GsaSameParentFileMoveErrorDetail -from .models.gsa_same_parent_folder_move_error_detail import GsaSameParentFolderMoveErrorDetail +from .models.gsa_save_search_request import GsaSaveSearchRequest from .models.gsa_schema_too_new_add_database_validation_issue import ( GsaSchemaTooNewAddDatabaseValidationIssue, ) @@ -1440,9 +952,8 @@ GsaSchemaTooOldAddDatabaseValidationIssue, ) from .models.gsa_search_cluster_status import GsaSearchClusterStatus +from .models.gsa_search_detail import GsaSearchDetail from .models.gsa_search_index_status import GsaSearchIndexStatus -from .models.gsa_search_mask import GsaSearchMask -from .models.gsa_search_mask_info import GsaSearchMaskInfo from .models.gsa_search_mask_usage_data_modification_error_detail import ( GsaSearchMaskUsageDataModificationErrorDetail, ) @@ -1450,20 +961,13 @@ from .models.gsa_search_response import GsaSearchResponse from .models.gsa_search_result import GsaSearchResult from .models.gsa_search_results_request import GsaSearchResultsRequest -from .models.gsa_search_service_status import GsaSearchServiceStatus -from .models.gsa_search_template import GsaSearchTemplate -from .models.gsa_search_template_attribute_item import GsaSearchTemplateAttributeItem -from .models.gsa_search_template_info import GsaSearchTemplateInfo -from .models.gsa_search_template_item import GsaSearchTemplateItem -from .models.gsa_search_template_item_type import GsaSearchTemplateItemType -from .models.gsa_search_template_link_item import GsaSearchTemplateLinkItem -from .models.gsa_search_template_tabular_column_item import GsaSearchTemplateTabularColumnItem from .models.gsa_searchable_record_property import GsaSearchableRecordProperty +from .models.gsa_security_attribute_grouping import GsaSecurityAttributeGrouping from .models.gsa_security_attribute_usage_data_modification_error_detail import ( GsaSecurityAttributeUsageDataModificationErrorDetail, ) from .models.gsa_security_groups import GsaSecurityGroups -from .models.gsa_selection import GsaSelection +from .models.gsa_selection_search import GsaSelectionSearch from .models.gsa_series_graph import GsaSeriesGraph from .models.gsa_set_date_time_datum import GsaSetDateTimeDatum from .models.gsa_set_datum import GsaSetDatum @@ -1483,9 +987,6 @@ from .models.gsa_set_short_text_datum import GsaSetShortTextDatum from .models.gsa_set_tabular_datum import GsaSetTabularDatum from .models.gsa_set_tabular_datum_row import GsaSetTabularDatumRow -from .models.gsa_set_unit_equivalent import GsaSetUnitEquivalent -from .models.gsa_set_unit_equivalents_exception import GsaSetUnitEquivalentsException -from .models.gsa_set_unit_equivalents_info import GsaSetUnitEquivalentsInfo from .models.gsa_short_name_property import GsaShortNameProperty from .models.gsa_short_text_aggregation import GsaShortTextAggregation from .models.gsa_short_text_aggregation_datum_criterion import GsaShortTextAggregationDatumCriterion @@ -1495,12 +996,10 @@ from .models.gsa_short_text_datum_exists_criterion import GsaShortTextDatumExistsCriterion from .models.gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion from .models.gsa_significant_figures_info import GsaSignificantFiguresInfo -from .models.gsa_similarity_setting import GsaSimilaritySetting -from .models.gsa_similarity_settings import GsaSimilaritySettings from .models.gsa_simple_attribute_to_export import GsaSimpleAttributeToExport from .models.gsa_slim_attribute import GsaSlimAttribute -from .models.gsa_slim_attribute_with_help_path import GsaSlimAttributeWithHelpPath from .models.gsa_slim_configuration import GsaSlimConfiguration +from .models.gsa_slim_constant import GsaSlimConstant from .models.gsa_slim_database import GsaSlimDatabase from .models.gsa_slim_discrete_type import GsaSlimDiscreteType from .models.gsa_slim_entity import GsaSlimEntity @@ -1509,90 +1008,45 @@ from .models.gsa_slim_identified_entity import GsaSlimIdentifiedEntity from .models.gsa_slim_layout import GsaSlimLayout from .models.gsa_slim_layout_section import GsaSlimLayoutSection -from .models.gsa_slim_localized_entity import GsaSlimLocalizedEntity from .models.gsa_slim_named_entity import GsaSlimNamedEntity +from .models.gsa_slim_named_unit import GsaSlimNamedUnit from .models.gsa_slim_objects import GsaSlimObjects from .models.gsa_slim_parameter import GsaSlimParameter -from .models.gsa_slim_parameter_with_help_path import GsaSlimParameterWithHelpPath +from .models.gsa_slim_permission import GsaSlimPermission +from .models.gsa_slim_permission_category import GsaSlimPermissionCategory from .models.gsa_slim_profile import GsaSlimProfile from .models.gsa_slim_profile_table import GsaSlimProfileTable from .models.gsa_slim_record_history import GsaSlimRecordHistory from .models.gsa_slim_record_link_group import GsaSlimRecordLinkGroup from .models.gsa_slim_record_version import GsaSlimRecordVersion from .models.gsa_slim_replacement_string import GsaSlimReplacementString -from .models.gsa_slim_search_mask import GsaSlimSearchMask -from .models.gsa_slim_search_template import GsaSlimSearchTemplate from .models.gsa_slim_subset import GsaSlimSubset from .models.gsa_slim_table import GsaSlimTable from .models.gsa_slim_typed_attribute import GsaSlimTypedAttribute from .models.gsa_slim_unit import GsaSlimUnit -from .models.gsa_smart_attributes_error_detail import GsaSmartAttributesErrorDetail -from .models.gsa_smart_attributes_error_reason import GsaSmartAttributesErrorReason -from .models.gsa_smart_attributes_record_link_group_error_detail import ( - GsaSmartAttributesRecordLinkGroupErrorDetail, -) -from .models.gsa_smart_link import GsaSmartLink -from .models.gsa_smart_link_create_put_layout_item import GsaSmartLinkCreatePutLayoutItem -from .models.gsa_smart_link_group_usage_data_modification_error_detail import ( - GsaSmartLinkGroupUsageDataModificationErrorDetail, -) -from .models.gsa_smart_record_link_group import GsaSmartRecordLinkGroup -from .models.gsa_smart_record_link_result import GsaSmartRecordLinkResult +from .models.gsa_slim_unit_system import GsaSlimUnitSystem +from .models.gsa_smtp_properties import GsaSmtpProperties from .models.gsa_sort_criterion import GsaSortCriterion from .models.gsa_sort_criterion_type import GsaSortCriterionType from .models.gsa_sort_direction import GsaSortDirection from .models.gsa_sort_type import GsaSortType from .models.gsa_sorting_value import GsaSortingValue from .models.gsa_sorting_value_type import GsaSortingValueType -from .models.gsa_source_cannot_be_target_smart_attributes_error_detail import ( - GsaSourceCannotBeTargetSmartAttributesErrorDetail, -) from .models.gsa_source_of_object_identifier import GsaSourceOfObjectIdentifier from .models.gsa_specific_values_specifier import GsaSpecificValuesSpecifier -from .models.gsa_sql_credentials import GsaSqlCredentials from .models.gsa_standard_name import GsaStandardName -from .models.gsa_standard_name_already_exists_error_detail import ( - GsaStandardNameAlreadyExistsErrorDetail, -) -from .models.gsa_standard_name_creation_exception import GsaStandardNameCreationException -from .models.gsa_standard_name_deletion_error_detail import GsaStandardNameDeletionErrorDetail -from .models.gsa_standard_name_deletion_error_reason import GsaStandardNameDeletionErrorReason -from .models.gsa_standard_name_deletion_exception import GsaStandardNameDeletionException -from .models.gsa_standard_name_error_detail import GsaStandardNameErrorDetail -from .models.gsa_standard_name_error_reason import GsaStandardNameErrorReason -from .models.gsa_standard_name_update_exception import GsaStandardNameUpdateException from .models.gsa_standard_names_info import GsaStandardNamesInfo -from .models.gsa_static_record_link import GsaStaticRecordLink from .models.gsa_static_record_link_group import GsaStaticRecordLinkGroup -from .models.gsa_static_record_link_result import GsaStaticRecordLinkResult from .models.gsa_string_sorting_value import GsaStringSortingValue from .models.gsa_subset import GsaSubset from .models.gsa_subsets_info import GsaSubsetsInfo -from .models.gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail import ( - GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail, -) -from .models.gsa_symbol_cannot_contain_comma_unit_error_detail import ( - GsaSymbolCannotContainCommaUnitErrorDetail, -) -from .models.gsa_t_item import GsaTItem from .models.gsa_table import GsaTable -from .models.gsa_table_creation_exception import GsaTableCreationException from .models.gsa_table_deletion_exception import GsaTableDeletionException -from .models.gsa_table_error_detail import GsaTableErrorDetail -from .models.gsa_table_error_reason import GsaTableErrorReason from .models.gsa_table_guid_property import GsaTableGuidProperty from .models.gsa_table_identity_property import GsaTableIdentityProperty from .models.gsa_table_name_property import GsaTableNameProperty -from .models.gsa_table_search_behaviour import GsaTableSearchBehaviour -from .models.gsa_table_type_contains_comma_error_detail import GsaTableTypeContainsCommaErrorDetail -from .models.gsa_table_type_error_detail import GsaTableTypeErrorDetail -from .models.gsa_table_type_error_reason import GsaTableTypeErrorReason -from .models.gsa_table_types_error_detail import GsaTableTypesErrorDetail -from .models.gsa_table_types_info import GsaTableTypesInfo -from .models.gsa_table_update_exception import GsaTableUpdateException from .models.gsa_tables_info import GsaTablesInfo from .models.gsa_tabular_attribute import GsaTabularAttribute -from .models.gsa_tabular_attribute_link import GsaTabularAttributeLink from .models.gsa_tabular_attribute_target import GsaTabularAttributeTarget from .models.gsa_tabular_attribute_usage_data_modification_error_detail import ( GsaTabularAttributeUsageDataModificationErrorDetail, @@ -1605,9 +1059,6 @@ ) from .models.gsa_tabular_column_no_such_entity_type import GsaTabularColumnNoSuchEntityType from .models.gsa_tabular_column_roll_up_type import GsaTabularColumnRollUpType -from .models.gsa_tabular_column_usage_data_modification_error_detail import ( - GsaTabularColumnUsageDataModificationErrorDetail, -) from .models.gsa_tabular_datum import GsaTabularDatum from .models.gsa_tabular_datum_cell import GsaTabularDatumCell from .models.gsa_tabular_datum_exists_criterion import GsaTabularDatumExistsCriterion @@ -1616,88 +1067,34 @@ from .models.gsa_tabular_datum_summary_row import GsaTabularDatumSummaryRow from .models.gsa_tabular_linking_value_criterion import GsaTabularLinkingValueCriterion from .models.gsa_tabular_row_export_behavior import GsaTabularRowExportBehavior -from .models.gsa_target_attribute import GsaTargetAttribute from .models.gsa_target_attribute_not_in_table_attribute_error_detail import ( GsaTargetAttributeNotInTableAttributeErrorDetail, ) -from .models.gsa_target_attribute_type import GsaTargetAttributeType from .models.gsa_target_attribute_type_attribute_error_detail import ( GsaTargetAttributeTypeAttributeErrorDetail, ) from .models.gsa_term_with_count import GsaTermWithCount from .models.gsa_text_match_behavior import GsaTextMatchBehavior from .models.gsa_threshold_type_attribute_error_detail import GsaThresholdTypeAttributeErrorDetail -from .models.gsa_too_long_code_currency_error_detail import GsaTooLongCodeCurrencyErrorDetail -from .models.gsa_too_many_attribute_pairs_smart_attributes_error_detail import ( - GsaTooManyAttributePairsSmartAttributesErrorDetail, -) -from .models.gsa_too_many_permissions_permission_category_error_detail import ( - GsaTooManyPermissionsPermissionCategoryErrorDetail, -) -from .models.gsa_too_many_permissions_replace_permission_category_error_detail import ( - GsaTooManyPermissionsReplacePermissionCategoryErrorDetail, -) -from .models.gsa_translate_between_guids_and_identities_response import ( - GsaTranslateBetweenGuidsAndIdentitiesResponse, -) from .models.gsa_translate_guids_to_identities_request import GsaTranslateGuidsToIdentitiesRequest -from .models.gsa_translate_identities_to_guids_request import GsaTranslateIdentitiesToGuidsRequest +from .models.gsa_translate_guids_to_identities_response import GsaTranslateGuidsToIdentitiesResponse from .models.gsa_unable_to_connect_add_database_validation_issue import ( GsaUnableToConnectAddDatabaseValidationIssue, ) from .models.gsa_unavailable_tabular_column import GsaUnavailableTabularColumn from .models.gsa_unit import GsaUnit -from .models.gsa_unit_as_exponent_unit_equation_error_detail import ( - GsaUnitAsExponentUnitEquationErrorDetail, -) from .models.gsa_unit_conversion_set import GsaUnitConversionSet from .models.gsa_unit_conversion_set_request import GsaUnitConversionSetRequest from .models.gsa_unit_conversions_info import GsaUnitConversionsInfo -from .models.gsa_unit_creation_exception import GsaUnitCreationException -from .models.gsa_unit_deletion_exception import GsaUnitDeletionException -from .models.gsa_unit_equation_error_detail import GsaUnitEquationErrorDetail -from .models.gsa_unit_equation_error_reason import GsaUnitEquationErrorReason from .models.gsa_unit_equivalent import GsaUnitEquivalent -from .models.gsa_unit_equivalent_error_detail import GsaUnitEquivalentErrorDetail -from .models.gsa_unit_equivalent_error_reason import GsaUnitEquivalentErrorReason from .models.gsa_unit_equivalents_info import GsaUnitEquivalentsInfo -from .models.gsa_unit_error_detail import GsaUnitErrorDetail -from .models.gsa_unit_error_reason import GsaUnitErrorReason from .models.gsa_unit_mapping import GsaUnitMapping from .models.gsa_unit_system import GsaUnitSystem from .models.gsa_unit_systems_info import GsaUnitSystemsInfo -from .models.gsa_unit_update_exception import GsaUnitUpdateException from .models.gsa_unit_usage import GsaUnitUsage -from .models.gsa_unit_usage_data_modification_error_detail import ( - GsaUnitUsageDataModificationErrorDetail, -) -from .models.gsa_unit_usage_type import GsaUnitUsageType -from .models.gsa_units_grouping_info import GsaUnitsGroupingInfo from .models.gsa_units_info import GsaUnitsInfo -from .models.gsa_unknown_unit_symbol_unit_equation_error_detail import ( - GsaUnknownUnitSymbolUnitEquationErrorDetail, -) -from .models.gsa_unresolved_attribute_guids_error_detail import ( - GsaUnresolvedAttributeGuidsErrorDetail, -) -from .models.gsa_unresolved_cross_database_record_link_group_guids_error_detail import ( - GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_unresolved_parameter_guids_error_detail import ( - GsaUnresolvedParameterGuidsErrorDetail, -) -from .models.gsa_unresolved_record_link_group_guids_error_detail import ( - GsaUnresolvedRecordLinkGroupGuidsErrorDetail, -) -from .models.gsa_unresolved_target_attribute import GsaUnresolvedTargetAttribute -from .models.gsa_update_access_control import GsaUpdateAccessControl -from .models.gsa_update_access_control_category import GsaUpdateAccessControlCategory -from .models.gsa_update_access_control_category_table_mapping import ( - GsaUpdateAccessControlCategoryTableMapping, -) from .models.gsa_update_all_profiles_info import GsaUpdateAllProfilesInfo from .models.gsa_update_attribute import GsaUpdateAttribute -from .models.gsa_update_attribute_based_access_control import GsaUpdateAttributeBasedAccessControl from .models.gsa_update_axis_name import GsaUpdateAxisName from .models.gsa_update_configuration import GsaUpdateConfiguration from .models.gsa_update_constant import GsaUpdateConstant @@ -1705,15 +1102,9 @@ from .models.gsa_update_cross_database_record_link_group import ( GsaUpdateCrossDatabaseRecordLinkGroup, ) -from .models.gsa_update_current_rule_engine import GsaUpdateCurrentRuleEngine from .models.gsa_update_data_rule import GsaUpdateDataRule from .models.gsa_update_database import GsaUpdateDatabase -from .models.gsa_update_database_security_groups import GsaUpdateDatabaseSecurityGroups from .models.gsa_update_date_time_attribute import GsaUpdateDateTimeAttribute -from .models.gsa_update_default_database import GsaUpdateDefaultDatabase -from .models.gsa_update_default_fallback_security_groups import ( - GsaUpdateDefaultFallbackSecurityGroups, -) from .models.gsa_update_default_profile import GsaUpdateDefaultProfile from .models.gsa_update_discrete_attribute import GsaUpdateDiscreteAttribute from .models.gsa_update_discrete_functional_attribute import GsaUpdateDiscreteFunctionalAttribute @@ -1731,8 +1122,7 @@ from .models.gsa_update_discrete_parameter_value import GsaUpdateDiscreteParameterValue from .models.gsa_update_discrete_range import GsaUpdateDiscreteRange from .models.gsa_update_discrete_type import GsaUpdateDiscreteType -from .models.gsa_update_display_names import GsaUpdateDisplayNames -from .models.gsa_update_display_names_response import GsaUpdateDisplayNamesResponse +from .models.gsa_update_dynamic_record_link_group import GsaUpdateDynamicRecordLinkGroup from .models.gsa_update_expression import GsaUpdateExpression from .models.gsa_update_file import GsaUpdateFile from .models.gsa_update_file_attribute import GsaUpdateFileAttribute @@ -1751,7 +1141,6 @@ from .models.gsa_update_integer_attribute import GsaUpdateIntegerAttribute from .models.gsa_update_job_request import GsaUpdateJobRequest from .models.gsa_update_layout import GsaUpdateLayout -from .models.gsa_update_layout_section import GsaUpdateLayoutSection from .models.gsa_update_linked_attribute_tabular_column import GsaUpdateLinkedAttributeTabularColumn from .models.gsa_update_linked_column_tabular_column import GsaUpdateLinkedColumnTabularColumn from .models.gsa_update_linked_record_tabular_column import GsaUpdateLinkedRecordTabularColumn @@ -1776,32 +1165,16 @@ from .models.gsa_update_parameter import GsaUpdateParameter from .models.gsa_update_parameter_content import GsaUpdateParameterContent from .models.gsa_update_parameter_value import GsaUpdateParameterValue -from .models.gsa_update_permission import GsaUpdatePermission -from .models.gsa_update_permission_access_control import GsaUpdatePermissionAccessControl -from .models.gsa_update_permission_based_access_control import GsaUpdatePermissionBasedAccessControl -from .models.gsa_update_permission_category import GsaUpdatePermissionCategory -from .models.gsa_update_permission_category_access_control import ( - GsaUpdatePermissionCategoryAccessControl, -) -from .models.gsa_update_permission_category_access_control_request import ( - GsaUpdatePermissionCategoryAccessControlRequest, -) from .models.gsa_update_picture_attribute import GsaUpdatePictureAttribute from .models.gsa_update_point_attribute import GsaUpdatePointAttribute from .models.gsa_update_profile import GsaUpdateProfile from .models.gsa_update_profile_table import GsaUpdateProfileTable -from .models.gsa_update_put_layout_item import GsaUpdatePutLayoutItem -from .models.gsa_update_put_permission import GsaUpdatePutPermission -from .models.gsa_update_put_permission_category import GsaUpdatePutPermissionCategory from .models.gsa_update_range_attribute import GsaUpdateRangeAttribute from .models.gsa_update_record_link_group import GsaUpdateRecordLinkGroup from .models.gsa_update_record_list_permission_flags import GsaUpdateRecordListPermissionFlags from .models.gsa_update_record_list_properties import GsaUpdateRecordListProperties from .models.gsa_update_replacement_string import GsaUpdateReplacementString -from .models.gsa_update_root_folder_error_detail import GsaUpdateRootFolderErrorDetail -from .models.gsa_update_run_status import GsaUpdateRunStatus from .models.gsa_update_short_text_attribute import GsaUpdateShortTextAttribute -from .models.gsa_update_smart_record_link_group import GsaUpdateSmartRecordLinkGroup from .models.gsa_update_standard_name import GsaUpdateStandardName from .models.gsa_update_static_record_link_group import GsaUpdateStaticRecordLinkGroup from .models.gsa_update_subset import GsaUpdateSubset @@ -1814,18 +1187,12 @@ from .models.gsa_update_unit_system import GsaUpdateUnitSystem from .models.gsa_update_user_permission import GsaUpdateUserPermission from .models.gsa_update_user_permissions_info import GsaUpdateUserPermissionsInfo -from .models.gsa_upgrade_database_exception import GsaUpgradeDatabaseException -from .models.gsa_upgrade_database_failure_reason import GsaUpgradeDatabaseFailureReason from .models.gsa_usage_data_modification_error_detail import GsaUsageDataModificationErrorDetail +from .models.gsa_user_or_group import GsaUserOrGroup from .models.gsa_user_permission import GsaUserPermission from .models.gsa_user_permissions_info import GsaUserPermissionsInfo from .models.gsa_user_role import GsaUserRole from .models.gsa_validate_attribute_request import GsaValidateAttributeRequest -from .models.gsa_validate_unit_equation_request import GsaValidateUnitEquationRequest -from .models.gsa_validate_unit_equation_response import GsaValidateUnitEquationResponse -from .models.gsa_value_not_provided_parameter_value_error_detail import ( - GsaValueNotProvidedParameterValueErrorDetail, -) from .models.gsa_value_specifier import GsaValueSpecifier from .models.gsa_value_specifier_type import GsaValueSpecifierType from .models.gsa_value_with_count_of_boolean import GsaValueWithCountOfBoolean @@ -1838,16 +1205,12 @@ from .models.gsa_version_number_property import GsaVersionNumberProperty from .models.gsa_version_state import GsaVersionState from .models.gsa_version_state_property import GsaVersionStateProperty -from .models.gsa_weighting_type import GsaWeightingType from .models.gsa_withdraw_record_version_control_exception import ( GsaWithdrawRecordVersionControlException, ) -from .models.gsa_xy_chart_template import GsaXYChartTemplate from .models.gsa_xy_chart_template_usage_data_modification_error_detail import ( GsaXYChartTemplateUsageDataModificationErrorDetail, ) -from .models.gsa_xy_chart_templates_info import GsaXYChartTemplatesInfo -from .models.gsa_xy_template_axis import GsaXYTemplateAxis from .models.jobqueue_files_body import JobqueueFilesBody from .models.json_patch_document import JsonPatchDocument from .models.microsoft_asp_net_core_mvc_formatters_i_output_formatter import ( @@ -1857,20 +1220,11 @@ from .models.system_net_http_status_code import SystemNetHttpStatusCode __all__ = [ - "AccessControlApi", - "AccessControlAttributeBasedCategoriesApi", - "AccessControlPermissionBasedSchemaApi", - "ActivityLogApi", "AggregationApi", - "BlobInfosApi", - "BlobsApi", "BulkApi", - "CurrenciesApi", "DataApi", "DataExportApi", - "DataUpdaterApi", "DatabaseApi", - "FindSimilarApi", "GraphApi", "HelpLocationApi", "IdentitiesApi", @@ -1882,7 +1236,7 @@ "ListManagementApi", "ListPermissionsApi", "MetricsApi", - "RecordLinksApi", + "PermissionBasedAccessControlApi", "RecordsRecordHistoriesApi", "RecordsRecordVersionsApi", "SchemaApi", @@ -1893,7 +1247,6 @@ "SchemaDatabasesApi", "SchemaDiscreteTypesDiscreteValuesApi", "SchemaDiscreteTypesApi", - "SchemaDisplayNamesApi", "SchemaExportersApi", "SchemaExpressionsApi", "SchemaGlobalStandardNamesApi", @@ -1904,19 +1257,15 @@ "SchemaParametersApi", "SchemaProfileTablesApi", "SchemaProfilesApi", - "SchemaQualitySystemsApi", "SchemaRecordLinkGroupsApi", "SchemaReplacementStringsApi", - "SchemaSearchMasksApi", - "SchemaSearchTemplatesApi", - "SchemaSecurityGroupsApi", "SchemaStandardNamesApi", "SchemaSubsetsApi", "SchemaTablesApi", - "SchemaUnitEquivalentsApi", "SchemaUnitsApi", - "SchemaXYChartTemplatesApi", "SearchApi", + "SelectionSearchesApi", + "ServerManagerApi", "StatusApi", "AttributesAttributeguidimportfileBody", "AttributesAttributeguidimportfileBody1", @@ -1930,39 +1279,12 @@ "FolderguidFilesBody1", "FolderguidFilesBody2", "GrantaMIRecordPropertyFakeAttributeIdentities", - "GrantaMISearchFreeTextIdentifiers", "GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "GsaAccessControlCategoriesInfo", - "GsaAccessControlCategory", - "GsaAccessControlCategoryCreationException", - "GsaAccessControlCategoryErrorDetail", - "GsaAccessControlCategoryErrorReason", - "GsaAccessControlCategoryInclude", - "GsaAccessControlCategoryNoSuchEntityType", - "GsaAccessControlCategoryTableMapping", - "GsaAccessControlCategoryUpdateException", - "GsaAccessControlInfo", - "GsaAccessControlMode", - "GsaAccessControlModeInfo", - "GsaActivityLogApplicationNameFilter", - "GsaActivityLogApplicationNamesCollectionFilter", - "GsaActivityLogCollectionMatchType", - "GsaActivityLogDatabaseKeyFilter", - "GsaActivityLogDateFilter", - "GsaActivityLogEntriesFilter", - "GsaActivityLogEntriesInfo", - "GsaActivityLogEntry", - "GsaActivityLogMatchType", - "GsaActivityLogUsageMode", - "GsaActivityLogUsageModeFilter", - "GsaActivityLogUsernameFilter", "GsaAddDatabase", "GsaAddDatabaseIssueType", - "GsaAddDatabaseSecurityGroups", "GsaAddDatabaseValidationIssue", "GsaAddDatabaseValidationResult", "GsaAddRecordHistoryToSubset", - "GsaAdditionalSqlParameters", "GsaAggregation", "GsaAggregationCriterion", "GsaAggregationDatum", @@ -1983,22 +1305,16 @@ "GsaAppendPointValues", "GsaApplicableDatum", "GsaApplicationsInfo", - "GsaApplyOptions", - "GsaAssociationChainCreatePutLayoutItem", "GsaAttribute", "GsaAttributeAggregation", "GsaAttributeAggregationCriterion", "GsaAttributeAggregationExistsCriterion", "GsaAttributeAggregationType", "GsaAttributeAggregationValueCriterion", - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "GsaAttributeBasedAccessControlInfo", - "GsaAttributeCreatePutLayoutItem", "GsaAttributeCreationException", "GsaAttributeCriterion", "GsaAttributeCriterionType", "GsaAttributeDeletionException", - "GsaAttributeDiscreteTypeMismatchErrorDetail", "GsaAttributeErrorDetail", "GsaAttributeErrorReason", "GsaAttributeExistsAggregation", @@ -2010,66 +1326,42 @@ "GsaAttributeMatchesCriterion", "GsaAttributeNoSuchEntityType", "GsaAttributeNotApplicableCriterion", - "GsaAttributeNotOnTableErrorDetail", - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail", "GsaAttributeReference", "GsaAttributeScaleType", "GsaAttributeSortCriterion", "GsaAttributeThresholdType", "GsaAttributeToExport", "GsaAttributeType", - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", "GsaAttributeUsageDataModificationErrorDetail", "GsaAttributeValidateResponse", "GsaAttributeValueAggregation", "GsaAttributesInfo", "GsaAxisName", - "GsaBlobInfoDto", "GsaBooleanCriterion", "GsaBoostByGuid", "GsaBoostByIdentity", - "GsaBracketMismatchUnitEquationErrorDetail", "GsaBulkInfo", "GsaBulkRequest", "GsaBulkRequestHttpMethod", "GsaBulkRequestItem", "GsaBulkResponseItem", "GsaCalendarInterval", - "GsaCategoryReplacePermissionCategoryErrorDetail", - "GsaChartData", - "GsaChartDataType", - "GsaCircularReferenceFolderMoveErrorDetail", - "GsaCodeMissingCurrencyErrorDetail", - "GsaCodeWhitespaceCurrencyErrorDetail", - "GsaConfigInvalidJsonFileErrorDetail", "GsaConfiguration", - "GsaConfigurationDetails", "GsaConfigurationsInfo", "GsaConnectionDetails", "GsaConstant", - "GsaConstantCreationException", "GsaConstantDeletionException", - "GsaConstantErrorDetail", - "GsaConstantErrorReason", - "GsaConstantUpdateException", - "GsaConstantUsageDataModificationErrorDetail", "GsaConstantsInfo", - "GsaContinuousQualitySystem", "GsaContinuousRange", "GsaCopyRecordHistory", - "GsaCreateAccessControlCategory", - "GsaCreateAccessControlCategoryTableMapping", "GsaCreateAttribute", "GsaCreateAttributeLinkPair", "GsaCreateAxisName", "GsaCreateConfiguration", "GsaCreateConstant", "GsaCreateContinuousRange", - "GsaCreateCrossDatabaseLinkTarget", "GsaCreateCrossDatabaseRecordLinkGroup", "GsaCreateDataRule", - "GsaCreateDataUpdateServerApiRequest", "GsaCreateDateTimeAttribute", "GsaCreateDiscreteAttribute", "GsaCreateDiscreteFunctionalAttribute", @@ -2081,6 +1373,7 @@ "GsaCreateDiscreteParameterValue", "GsaCreateDiscreteRange", "GsaCreateDiscreteType", + "GsaCreateDynamicRecordLinkGroup", "GsaCreateExpression", "GsaCreateFileAttribute", "GsaCreateFloatFunctionalAttribute", @@ -2118,47 +1411,31 @@ "GsaCreateParameter", "GsaCreateParameterContent", "GsaCreateParameterValue", - "GsaCreatePermission", - "GsaCreatePermissionCategory", "GsaCreatePictureAttribute", "GsaCreatePointAttribute", "GsaCreateProfile", "GsaCreateProfileTable", - "GsaCreatePutLayoutItem", - "GsaCreatePutPermission", - "GsaCreatePutPermissionCategory", "GsaCreateRangeAttribute", "GsaCreateRecordHistory", "GsaCreateRecordLinkGroup", "GsaCreateRecordList", "GsaCreateRecordListItemsInfo", "GsaCreateReplacementString", + "GsaCreateSearchRequest", "GsaCreateShortTextAttribute", - "GsaCreateSmartLinkTarget", - "GsaCreateSmartRecordLinkGroup", "GsaCreateStandardName", - "GsaCreateStaticLinkTarget", "GsaCreateStaticRecordLinkGroup", "GsaCreateSubset", "GsaCreateTable", "GsaCreateTabularAttribute", "GsaCreateTabularColumn", "GsaCreateUnit", - "GsaCreateUnitMapping", "GsaCreateUnitSystem", "GsaCreatedByUserProperty", "GsaCreatedDateProperty", "GsaCriterion", "GsaCriterionType", - "GsaCrossDatabaseLink", - "GsaCrossDatabaseLinkCreatePutLayoutItem", - "GsaCrossDatabaseRecordLink", "GsaCrossDatabaseRecordLinkGroup", - "GsaCrossDatabaseRecordLinkResult", - "GsaCurrenciesInfo", - "GsaCurrency", - "GsaCurrencyErrorDetail", - "GsaCurrencyErrorReason", "GsaCurrentUser", "GsaDataExportApplicableDatum", "GsaDataExportBinaryData", @@ -2208,25 +1485,11 @@ "GsaDataModificationErrorReason", "GsaDataRule", "GsaDataRulesInfo", - "GsaDataSource", - "GsaDataUpdate", - "GsaDataUpdateHeader", - "GsaDataUpdateRunInfo", - "GsaDataUpdateToken", - "GsaDataUpdaterJob", - "GsaDataUpdaterJobStatus", - "GsaDataUpdaterJobType", - "GsaDataUpdaterProject", "GsaDataUsageDataModificationErrorDetail", "GsaDatabase", - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "GsaDatabaseIssues", "GsaDatabaseKeyProperty", - "GsaDatabaseSecurityGroups", - "GsaDatabaseSecurityGroupsInfo", "GsaDatabaseStatus", "GsaDatabaseStatusInformation", - "GsaDatabaseUserCapabilities", "GsaDatabasesInfo", "GsaDateTimeAggregation", "GsaDateTimeAggregationDatumCriterion", @@ -2254,20 +1517,11 @@ "GsaDatumRollupType", "GsaDatumType", "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", - "GsaDefaultFallbackSecurityGroups", "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", - "GsaDefaultLayoutGuidErrorDetail", - "GsaDefaultParameterValueGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexParameterErrorDetail", - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", "GsaDefaultParameterValueUsageDataModificationErrorDetail", - "GsaDefaultSubsetGuidErrorDetail", "GsaDeleteRecordListItem", "GsaDeleteRecordListItems", - "GsaDescriptionLengthFileErrorDetail", "GsaDiscreteAttribute", - "GsaDiscreteChartData", "GsaDiscreteDatum", "GsaDiscreteDatumExistsCriterion", "GsaDiscreteFunctionalAttribute", @@ -2294,7 +1548,6 @@ "GsaDiscreteParameterNameConstraint", "GsaDiscreteParameterValue", "GsaDiscreteParameterValueConstraint", - "GsaDiscreteQualitySystem", "GsaDiscreteRange", "GsaDiscreteRangeDatumCriterion", "GsaDiscreteSeries", @@ -2308,60 +1561,32 @@ "GsaDiscreteType", "GsaDiscreteTypeDeletionException", "GsaDiscreteTypeUsage", - "GsaDiscreteTypeUsageType", "GsaDiscreteTypesInfo", "GsaDiscreteValue", "GsaDiscreteValueAggregateErrorReason", "GsaDiscreteValueAggregateException", - "GsaDiscreteValueNotInDiscreteTypeErrorDetail", "GsaDiscreteValuesCreateDiscreteValue", "GsaDiscreteValuesDiscreteValue", "GsaDiscreteValuesDiscreteValuesInfo", "GsaDiscreteValuesReplaceDiscreteValuesInfo", "GsaDiscreteValuesUpdateDiscreteValue", "GsaDiskStatus", - "GsaDisplayNameEmptyErrorDetail", - "GsaDisplayNameLanguageNotProvidedErrorDetail", - "GsaDisplayNameLanguageNotSupportedErrorDetail", - "GsaDisplayNamesImportErrorDetail", - "GsaDisplayNamesImportErrorReason", - "GsaDisplayNamesImportException", - "GsaDisplayNamesInfo", - "GsaDivideByZeroUnitEquationErrorDetail", "GsaDoubleSortingValue", - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "GsaDuplicateCodeCurrencyErrorDetail", "GsaDuplicateDatabaseAddDatabaseValidationIssue", - "GsaDuplicateDiscreteValueErrorDetail", "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", "GsaDuplicateGuidAddDatabaseValidationIssue", "GsaDuplicateKeyAddDatabaseValidationIssue", - "GsaDuplicateMappedAttributeGuidsErrorDetail", - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateMappedParameterGuidsErrorDetail", - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateNameCurrencyErrorDetail", "GsaDuplicateParameterGuidsAttributeErrorDetail", - "GsaDuplicatePermissionGuidsAccessControlErrorDetail", - "GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "GsaDuplicateSymbolUnitErrorDetail", - "GsaDuplicateTableErrorDetail", "GsaDuplicateTabularColumnGuidsErrorDetail", "GsaDuplicateTabularColumnNamesErrorDetail", "GsaDuplicateVersionGuidAddDatabaseValidationIssue", + "GsaDynamicLinkGroupUsageDataModificationErrorDetail", + "GsaDynamicRecordLinkGroup", "GsaEmptyAxisNameAttributeErrorDetail", - "GsaEmptySymbolUnitErrorDetail", - "GsaEmptyTableTypeErrorDetail", "GsaEnabledLicensesInfo", "GsaEntityAlreadyExistsErrorDetail", "GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "GsaEntityType", - "GsaEquationUnitErrorDetail", - "GsaErrorCode", "GsaErrorDetail", - "GsaErrorResponse", - "GsaExceptionInformation", "GsaExcludeValuesSpecifier", "GsaExistingTabularColumnGuidErrorDetail", "GsaExportFailure", @@ -2372,28 +1597,14 @@ "GsaExpressionUsageDataModificationErrorDetail", "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", "GsaExpressionsInfo", - "GsaFileAlreadyExistsFileMoveErrorDetail", "GsaFileAttribute", - "GsaFileCreationException", "GsaFileDatum", "GsaFileDatumCriterion", "GsaFileDatumExistsCriterion", - "GsaFileErrorDetail", - "GsaFileErrorReason", "GsaFileHeader", - "GsaFileHeaderInfo", - "GsaFileMoveErrorDetail", - "GsaFileMoveErrorReason", - "GsaFileMoveException", - "GsaFileNameFileErrorDetail", - "GsaFileNameFolderErrorDetail", "GsaFilePrefixDatumCriterion", - "GsaFileUpdateException", "GsaFilesInfo", - "GsaFindSimilarRequest", - "GsaFindSimilarResponse", - "GsaFindSimilarResult", - "GsaFindSimilarSearchCriterion", + "GsaFindSearchRequest", "GsaFindStandardNames", "GsaFloatFunctionalAggregation", "GsaFloatFunctionalAggregationDatumCriterion", @@ -2415,20 +1626,7 @@ "GsaFloatSeriesGraph", "GsaFloatSeriesPoint", "GsaFolder", - "GsaFolderAlreadyExistsFolderMoveErrorDetail", - "GsaFolderCreationException", - "GsaFolderDeletionErrorDetail", - "GsaFolderDeletionErrorReason", - "GsaFolderDeletionException", - "GsaFolderErrorDetail", - "GsaFolderErrorReason", - "GsaFolderMoveErrorDetail", - "GsaFolderMoveErrorReason", - "GsaFolderMoveException", - "GsaFolderType", - "GsaFolderUpdateException", "GsaFoldersInfo", - "GsaForbidOrphansRecordLinkGroupErrorDetail", "GsaFreeTextAggregation", "GsaFreeTextAggregationCriterion", "GsaFreeTextCriterion", @@ -2436,17 +1634,14 @@ "GsaFullLayoutSection", "GsaFullNameProperty", "GsaFuncNoParamsAttributeErrorDetail", - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail", "GsaFunctionalDatumParameterInfo", "GsaFunctionalParameterSetting", "GsaFunctionalType", - "GsaGeneralUnitEquationErrorDetail", "GsaGeneratedIntegrationSchemaOfObjectIdentifier", "GsaGetJobsResponse", "GsaGetJobsSummaryResponse", "GsaGetModifiableRecordVersionControlException", "GsaGetUnitConversionsRequest", - "GsaGetUnitEquivalentsException", "GsaGraph", "GsaGraphDecorationType", "GsaGraphEvaluationSettings", @@ -2455,7 +1650,6 @@ "GsaGraphType", "GsaGraphValue", "GsaGraphValueType", - "GsaGrid", "GsaGridGraph", "GsaGuidOnlyAttribute", "GsaGuidOnlyDiscreteType", @@ -2464,7 +1658,6 @@ "GsaGuidOnlyLayout", "GsaGuidOnlyMappingOfObjectIdentifier", "GsaGuidOnlySourceOfObjectIdentifier", - "GsaHelpPathsValidationResponse", "GsaHistogram", "GsaHistogramBucket", "GsaHyperlinkAttribute", @@ -2473,17 +1666,12 @@ "GsaHyperlinkDatumExistsCriterion", "GsaHyperlinkPrefixDatumCriterion", "GsaHyperlinkTarget", - "GsaInUseParameterValueErrorDetail", - "GsaInclusiveness", - "GsaIncompatibleUnitsErrorDetail", "GsaIndexRecordFailure", "GsaIndirectLinks", - "GsaInputConnectionDetails", "GsaInputValidationErrorDetail", "GsaIntegerAggregation", "GsaIntegerAggregationDatumCriterion", "GsaIntegerAttribute", - "GsaIntegerChartData", "GsaIntegerDatum", "GsaIntegerDatumCriterion", "GsaIntegerDatumExistsCriterion", @@ -2498,8 +1686,6 @@ "GsaIntegrationSchemaGenerationErrorDetail", "GsaIntegrationSchemaOfObjectIdentifier", "GsaIntegrationSchemaStatus", - "GsaInvalidEquivalenceTargetErrorDetail", - "GsaInvalidExchangeRateCurrencyErrorDetail", "GsaInvalidKeyAddDatabaseValidationIssue", "GsaInvalidParentStateErrorDetail", "GsaInvalidVersionStateErrorDetail", @@ -2519,7 +1705,6 @@ "GsaLayoutSectionsInfo", "GsaLayoutTabularColumn", "GsaLayoutsInfo", - "GsaLink", "GsaLinkAggregation", "GsaLinkAggregationDatumCriterion", "GsaLinkAttributeToExport", @@ -2572,11 +1757,9 @@ "GsaLocalRangeTabularColumn", "GsaLocalRowsBehavior", "GsaLocalShortTextTabularColumn", - "GsaLogScaleNegativeParameterValueErrorDetail", "GsaLogicalAggregation", "GsaLogicalAggregationDatumCriterion", "GsaLogicalAttribute", - "GsaLogicalChartData", "GsaLogicalDatum", "GsaLogicalDatumCriterion", "GsaLogicalDatumExistsCriterion", @@ -2586,9 +1769,7 @@ "GsaLongTextDatumCriterion", "GsaLongTextDatumExistsCriterion", "GsaLongTextPrefixDatumCriterion", - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", "GsaMappingOfObjectIdentifier", - "GsaMatchMode", "GsaMathsContent", "GsaMathsFunctionalAttribute", "GsaMathsFunctionalAttributeErrorDetail", @@ -2596,8 +1777,6 @@ "GsaMathsFunctionalDatumExistsCriterion", "GsaMathsFunctionalErrorDetail", "GsaMathsFunctionalErrorReason", - "GsaMaxPermissionsReachedPermissionErrorDetail", - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", "GsaMfaExpressionErrorDetail", "GsaMfaExpressionErrorReason", "GsaMiVersion", @@ -2606,30 +1785,12 @@ "GsaMoveFile", "GsaMoveFolder", "GsaMoveRecordHistory", - "GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", "GsaNameAlreadyExistsErrorDetail", - "GsaNameAlreadySpecifiedErrorDetail", - "GsaNameMissingCurrencyErrorDetail", "GsaNameNotProvidedErrorDetail", - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "GsaNameWhitespaceCurrencyErrorDetail", - "GsaNameWhitespaceParameterValueErrorDetail", "GsaNamedCriterion", - "GsaNamedEntityAccessControlCategoryErrorDetail", "GsaNamedEntityAttributeErrorDetail", - "GsaNamedEntityConstantErrorDetail", "GsaNamedEntityErrorDetail", "GsaNamedEntityErrorReason", - "GsaNamedEntityFileErrorDetail", - "GsaNamedEntityFolderErrorDetail", - "GsaNamedEntityParameterErrorDetail", - "GsaNamedEntityParameterValueErrorDetail", - "GsaNamedEntityPermissionErrorDetail", - "GsaNamedEntityRecordLinkGroupErrorDetail", - "GsaNamedEntityTableErrorDetail", - "GsaNamedEntityUnitErrorDetail", "GsaNewLayoutAssociationChainItem", "GsaNewLayoutAssociationChainLink", "GsaNewLayoutAttributeItem", @@ -2638,47 +1799,23 @@ "GsaNewLayoutItemType", "GsaNewLayoutRecordLinkItem", "GsaNewLayoutSmartLinkItem", - "GsaNoAttributePairsSmartAttributesErrorDetail", - "GsaNoDataFileErrorDetail", "GsaNoExpressionsMathsFunctionalErrorDetail", - "GsaNoFileFileErrorDetail", - "GsaNoParameterValuesParameterErrorDetail", - "GsaNoPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchAttributeSmartAttributesErrorDetail", - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "GsaNoSuchCategoryAccessControlErrorDetail", - "GsaNoSuchEntityAccessControlCategoryErrorDetail", "GsaNoSuchEntityAttributeErrorDetail", "GsaNoSuchEntityTabularColumnErrorDetail", "GsaNoSuchExpressionsMathsFunctionalErrorDetail", - "GsaNoSuchNewParentFileMoveErrorDetail", - "GsaNoSuchNewParentFolderMoveErrorDetail", "GsaNoSuchParameterValueParameterContentErrorDetail", - "GsaNoSuchPermissionAccessControlErrorDetail", - "GsaNoSuchPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "GsaNoSuchUnitConstantErrorDetail", - "GsaNoSuchUnitParameterErrorDetail", - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "GsaNoSuchUnitUnitEquivalentErrorDetail", "GsaNoValueExistsGraphValue", "GsaNoValuesSpecifier", - "GsaNonCustomStandardNameCannotBeChangedErrorDetail", "GsaNotApplicableDatum", "GsaNotTheLatestVersionErrorDetail", "GsaNotVersionedErrorDetail", - "GsaNumberParsingUnitEquationErrorDetail", "GsaNumericGraphParameterValue", "GsaNumericParameter", "GsaNumericParameterConstraint", "GsaNumericParameterContent", "GsaNumericParameterDataValue", "GsaNumericParameterValue", - "GsaNumericRestrictedInterpolationParameterErrorDetail", "GsaObjectIdentifier", - "GsaPaginatedItemType", - "GsaPaginatedResponseOf", - "GsaPaginationLinks", "GsaPagingOptions", "GsaParameter", "GsaParameterConstraint", @@ -2690,11 +1827,8 @@ "GsaParameterContentMathsFunctionalErrorDetail", "GsaParameterContentMissingArgument", "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", - "GsaParameterCreationException", "GsaParameterDataValue", "GsaParameterDeletionException", - "GsaParameterErrorDetail", - "GsaParameterErrorReason", "GsaParameterInfo", "GsaParameterInfoInterpolationType", "GsaParameterInfoParameterType", @@ -2704,44 +1838,14 @@ "GsaParameterSettingDefinedAt", "GsaParameterType", "GsaParameterTypeParameterContentErrorDetail", - "GsaParameterTypeParameterErrorDetail", - "GsaParameterUpdateException", - "GsaParameterUsageDataModificationErrorDetail", "GsaParameterValue", - "GsaParameterValueCreationException", "GsaParameterValueDeletionException", - "GsaParameterValueErrorDetail", - "GsaParameterValueErrorReason", - "GsaParameterValueParameterErrorDetail", "GsaParameterValueType", - "GsaParameterValueTypeParameterValueErrorDetail", - "GsaParameterValueUpdateException", - "GsaParameterValueUsedByType", "GsaParameterWithDataValue", "GsaParametersInfo", "GsaPermission", - "GsaPermissionAccessControl", - "GsaPermissionBasedAccessControlInfo", - "GsaPermissionCategoriesAccessControlErrorDetail", - "GsaPermissionCategoriesAccessControlErrorReason", - "GsaPermissionCategoriesAccessControlUpdateException", "GsaPermissionCategoriesInfo", "GsaPermissionCategory", - "GsaPermissionCategoryAccessControl", - "GsaPermissionCategoryAccessControlInfo", - "GsaPermissionCategoryCreationException", - "GsaPermissionCategoryErrorDetail", - "GsaPermissionCategoryErrorReason", - "GsaPermissionCategoryReplaceException", - "GsaPermissionCategoryUpdateException", - "GsaPermissionCreationException", - "GsaPermissionDeletionErrorDetail", - "GsaPermissionDeletionErrorReason", - "GsaPermissionDeletionException", - "GsaPermissionErrorDetail", - "GsaPermissionErrorReason", - "GsaPermissionPermissionCategoryErrorDetail", - "GsaPermissionUpdateException", "GsaPermissionsInfo", "GsaPictureAttribute", "GsaPictureDatum", @@ -2750,7 +1854,6 @@ "GsaPointAggregation", "GsaPointAggregationDatumCriterion", "GsaPointAttribute", - "GsaPointChartData", "GsaPointDataValue", "GsaPointDatum", "GsaPointDatumCriterion", @@ -2764,15 +1867,6 @@ "GsaProfileTable", "GsaProfileTablesInfo", "GsaProperty", - "GsaPutLayoutItem", - "GsaPutPermission", - "GsaPutPermissionCategory", - "GsaPutType", - "GsaQualityDiscreteValue", - "GsaQualitySystem", - "GsaQualitySystemGuidErrorDetail", - "GsaQualitySystemType", - "GsaQualitySystemsInfo", "GsaQueryAttribute", "GsaQueryAttributeFilter", "GsaQueryAttributeInfo", @@ -2789,25 +1883,9 @@ "GsaQueryDiscreteTypeProperties", "GsaQueryDiscreteTypesInfo", "GsaQueryDiscreteTypesRequest", - "GsaQueryLayout", - "GsaQueryLayoutFilter", - "GsaQueryLayoutItem", - "GsaQueryLayoutItemFilter", - "GsaQueryLayoutItemProperties", - "GsaQueryLayoutProperties", - "GsaQueryLayoutSection", - "GsaQueryLayoutSectionFilter", - "GsaQueryLayoutSectionProperties", - "GsaQueryLayoutSectionsInfo", - "GsaQueryLayoutSectionsRequest", - "GsaQueryLayoutsInfo", - "GsaQueryLayoutsRequest", "GsaQuerySlimDiscreteType", "GsaQuerySlimDiscreteTypeProperties", - "GsaQuerySlimEntity", - "GsaQuerySlimEntityProperties", "GsaQuerySlimNamedEntity", - "GsaQuerySlimNamedEntityFilter", "GsaQuerySlimNamedEntityProperties", "GsaQuerySlimTypedAttribute", "GsaQuerySlimTypedAttributeProperties", @@ -2818,25 +1896,21 @@ "GsaQueryTablesRequest", "GsaQueryTabularAttributeTarget", "GsaQueryTabularAttributeTargetProperties", - "GsaQueryTabularColumn", - "GsaQueryTabularColumnProperties", "GsaQueryUnit", "GsaQueryUnitProperties", "GsaRangeAggregation", "GsaRangeAggregationDatumCriterion", "GsaRangeAttribute", - "GsaRangeChartData", "GsaRangeDatum", "GsaRangeDatumCriterion", "GsaRangeDatumExistsCriterion", - "GsaRangeEndpoint", "GsaRangeFixedWidthHistogramAggregationDatumCriterion", "GsaRangeGraphValue", "GsaRangeHistogramAggregation", "GsaRangeHistogramAggregationDatumCriterion", "GsaRecordAncestorCriterion", "GsaRecordAncestorHistoryCriterion", - "GsaRecordAndAttributeSelectionType", + "GsaRecordCapabilities", "GsaRecordColor", "GsaRecordColorProperty", "GsaRecordExportFailure", @@ -2846,18 +1920,9 @@ "GsaRecordHistoryGuidProperty", "GsaRecordHistoryMoveException", "GsaRecordHistoryReference", - "GsaRecordLink", - "GsaRecordLinkBase", - "GsaRecordLinkCreatePutLayoutItem", "GsaRecordLinkGroup", - "GsaRecordLinkGroupCreationException", - "GsaRecordLinkGroupErrorDetail", - "GsaRecordLinkGroupErrorReason", "GsaRecordLinkGroupType", - "GsaRecordLinkGroupUpdateException", "GsaRecordLinkGroupsInfo", - "GsaRecordLinkResult", - "GsaRecordLinkResults", "GsaRecordListHeader", "GsaRecordListHeadersInfo", "GsaRecordListItemsInfo", @@ -2877,74 +1942,45 @@ "GsaRecordReferenceType", "GsaRecordSubsetCriterion", "GsaRecordType", - "GsaRecordTypeCriterion", "GsaRecordTypeProperty", - "GsaRecordUserCapabilities", "GsaRecordVersion", "GsaRecordVersionReference", "GsaRecordWithData", "GsaReferencedByType", "GsaReferentialIntegrityModel", - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "GsaRegisterUpdateRequest", "GsaReleaseRecordVersionControlException", "GsaReleaseTableVersionControlException", "GsaReleasedDateProperty", "GsaRelevanceSortCriterion", "GsaRemoveRecordHistoryFromSubset", "GsaReorderSectionsInfo", - "GsaReplacePermissionCategoriesRequest", - "GsaReplacePermissionCategoryErrorDetail", - "GsaReplacePermissionCategoryErrorReason", "GsaReplacementString", "GsaReplacementStringsInfo", - "GsaResolveLinkTargetsInfo", - "GsaResolveLinkTargetsRequest", + "GsaResolvedLink", + "GsaResolvedLinkInfo", "GsaResolvedLinkTarget", - "GsaResolvedTargetAttribute", "GsaResponseOptions", "GsaResubmitJobRequest", - "GsaRetargetPotentialRequest", - "GsaRetargetRequest", - "GsaRetargetResult", - "GsaRetargetResultType", - "GsaRetargetResultsInfo", - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", "GsaRichTextType", "GsaRichTextValue", - "GsaRoleNotProvidedPermissionErrorDetail", "GsaRollupExportFailure", "GsaRollupReference", - "GsaRootFolderMoveErrorDetail", - "GsaRootRecordNotAvailableToRenameErrorDetail", - "GsaRuleEngine", - "GsaSameParentFileMoveErrorDetail", - "GsaSameParentFolderMoveErrorDetail", + "GsaSaveSearchRequest", "GsaSchemaTooNewAddDatabaseValidationIssue", "GsaSchemaTooOldAddDatabaseValidationIssue", "GsaSearchClusterStatus", + "GsaSearchDetail", "GsaSearchIndexStatus", - "GsaSearchMask", - "GsaSearchMaskInfo", "GsaSearchMaskUsageDataModificationErrorDetail", "GsaSearchRequest", "GsaSearchResponse", "GsaSearchResult", "GsaSearchResultsRequest", - "GsaSearchServiceStatus", - "GsaSearchTemplate", - "GsaSearchTemplateAttributeItem", - "GsaSearchTemplateInfo", - "GsaSearchTemplateItem", - "GsaSearchTemplateItemType", - "GsaSearchTemplateLinkItem", - "GsaSearchTemplateTabularColumnItem", "GsaSearchableRecordProperty", + "GsaSecurityAttributeGrouping", "GsaSecurityAttributeUsageDataModificationErrorDetail", "GsaSecurityGroups", - "GsaSelection", + "GsaSelectionSearch", "GsaSeriesGraph", "GsaSetDateTimeDatum", "GsaSetDatum", @@ -2964,9 +2000,6 @@ "GsaSetShortTextDatum", "GsaSetTabularDatum", "GsaSetTabularDatumRow", - "GsaSetUnitEquivalent", - "GsaSetUnitEquivalentsException", - "GsaSetUnitEquivalentsInfo", "GsaShortNameProperty", "GsaShortTextAggregation", "GsaShortTextAggregationDatumCriterion", @@ -2976,12 +2009,10 @@ "GsaShortTextDatumExistsCriterion", "GsaShortTextPrefixDatumCriterion", "GsaSignificantFiguresInfo", - "GsaSimilaritySetting", - "GsaSimilaritySettings", "GsaSimpleAttributeToExport", "GsaSlimAttribute", - "GsaSlimAttributeWithHelpPath", "GsaSlimConfiguration", + "GsaSlimConstant", "GsaSlimDatabase", "GsaSlimDiscreteType", "GsaSlimEntity", @@ -2990,78 +2021,45 @@ "GsaSlimIdentifiedEntity", "GsaSlimLayout", "GsaSlimLayoutSection", - "GsaSlimLocalizedEntity", "GsaSlimNamedEntity", + "GsaSlimNamedUnit", "GsaSlimObjects", "GsaSlimParameter", - "GsaSlimParameterWithHelpPath", + "GsaSlimPermission", + "GsaSlimPermissionCategory", "GsaSlimProfile", "GsaSlimProfileTable", "GsaSlimRecordHistory", "GsaSlimRecordLinkGroup", "GsaSlimRecordVersion", "GsaSlimReplacementString", - "GsaSlimSearchMask", - "GsaSlimSearchTemplate", "GsaSlimSubset", "GsaSlimTable", "GsaSlimTypedAttribute", "GsaSlimUnit", - "GsaSmartAttributesErrorDetail", - "GsaSmartAttributesErrorReason", - "GsaSmartAttributesRecordLinkGroupErrorDetail", - "GsaSmartLink", - "GsaSmartLinkCreatePutLayoutItem", - "GsaSmartLinkGroupUsageDataModificationErrorDetail", - "GsaSmartRecordLinkGroup", - "GsaSmartRecordLinkResult", + "GsaSlimUnitSystem", + "GsaSmtpProperties", "GsaSortCriterion", "GsaSortCriterionType", "GsaSortDirection", "GsaSortType", "GsaSortingValue", "GsaSortingValueType", - "GsaSourceCannotBeTargetSmartAttributesErrorDetail", "GsaSourceOfObjectIdentifier", "GsaSpecificValuesSpecifier", - "GsaSqlCredentials", "GsaStandardName", - "GsaStandardNameAlreadyExistsErrorDetail", - "GsaStandardNameCreationException", - "GsaStandardNameDeletionErrorDetail", - "GsaStandardNameDeletionErrorReason", - "GsaStandardNameDeletionException", - "GsaStandardNameErrorDetail", - "GsaStandardNameErrorReason", - "GsaStandardNameUpdateException", "GsaStandardNamesInfo", - "GsaStaticRecordLink", "GsaStaticRecordLinkGroup", - "GsaStaticRecordLinkResult", "GsaStringSortingValue", "GsaSubset", "GsaSubsetsInfo", - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - "GsaSymbolCannotContainCommaUnitErrorDetail", - "GsaTItem", "GsaTable", - "GsaTableCreationException", "GsaTableDeletionException", - "GsaTableErrorDetail", - "GsaTableErrorReason", "GsaTableGuidProperty", "GsaTableIdentityProperty", "GsaTableNameProperty", - "GsaTableSearchBehaviour", - "GsaTableTypeContainsCommaErrorDetail", - "GsaTableTypeErrorDetail", - "GsaTableTypeErrorReason", - "GsaTableTypesErrorDetail", - "GsaTableTypesInfo", - "GsaTableUpdateException", "GsaTablesInfo", "GsaTabularAttribute", - "GsaTabularAttributeLink", "GsaTabularAttributeTarget", "GsaTabularAttributeUsageDataModificationErrorDetail", "GsaTabularAttributeWithColumns", @@ -3070,7 +2068,6 @@ "GsaTabularColumnNameNotProvidedErrorDetail", "GsaTabularColumnNoSuchEntityType", "GsaTabularColumnRollUpType", - "GsaTabularColumnUsageDataModificationErrorDetail", "GsaTabularDatum", "GsaTabularDatumCell", "GsaTabularDatumExistsCriterion", @@ -3079,70 +2076,36 @@ "GsaTabularDatumSummaryRow", "GsaTabularLinkingValueCriterion", "GsaTabularRowExportBehavior", - "GsaTargetAttribute", "GsaTargetAttributeNotInTableAttributeErrorDetail", - "GsaTargetAttributeType", "GsaTargetAttributeTypeAttributeErrorDetail", "GsaTermWithCount", "GsaTextMatchBehavior", "GsaThresholdTypeAttributeErrorDetail", - "GsaTooLongCodeCurrencyErrorDetail", - "GsaTooManyAttributePairsSmartAttributesErrorDetail", - "GsaTooManyPermissionsPermissionCategoryErrorDetail", - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - "GsaTranslateBetweenGuidsAndIdentitiesResponse", "GsaTranslateGuidsToIdentitiesRequest", - "GsaTranslateIdentitiesToGuidsRequest", + "GsaTranslateGuidsToIdentitiesResponse", "GsaUnableToConnectAddDatabaseValidationIssue", "GsaUnavailableTabularColumn", "GsaUnit", - "GsaUnitAsExponentUnitEquationErrorDetail", "GsaUnitConversionSet", "GsaUnitConversionSetRequest", "GsaUnitConversionsInfo", - "GsaUnitCreationException", - "GsaUnitDeletionException", - "GsaUnitEquationErrorDetail", - "GsaUnitEquationErrorReason", "GsaUnitEquivalent", - "GsaUnitEquivalentErrorDetail", - "GsaUnitEquivalentErrorReason", "GsaUnitEquivalentsInfo", - "GsaUnitErrorDetail", - "GsaUnitErrorReason", "GsaUnitMapping", "GsaUnitSystem", "GsaUnitSystemsInfo", - "GsaUnitUpdateException", "GsaUnitUsage", - "GsaUnitUsageDataModificationErrorDetail", - "GsaUnitUsageType", - "GsaUnitsGroupingInfo", "GsaUnitsInfo", - "GsaUnknownUnitSymbolUnitEquationErrorDetail", - "GsaUnresolvedAttributeGuidsErrorDetail", - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedParameterGuidsErrorDetail", - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedTargetAttribute", - "GsaUpdateAccessControl", - "GsaUpdateAccessControlCategory", - "GsaUpdateAccessControlCategoryTableMapping", "GsaUpdateAllProfilesInfo", "GsaUpdateAttribute", - "GsaUpdateAttributeBasedAccessControl", "GsaUpdateAxisName", "GsaUpdateConfiguration", "GsaUpdateConstant", "GsaUpdateContinuousRange", "GsaUpdateCrossDatabaseRecordLinkGroup", - "GsaUpdateCurrentRuleEngine", "GsaUpdateDataRule", "GsaUpdateDatabase", - "GsaUpdateDatabaseSecurityGroups", "GsaUpdateDateTimeAttribute", - "GsaUpdateDefaultDatabase", - "GsaUpdateDefaultFallbackSecurityGroups", "GsaUpdateDefaultProfile", "GsaUpdateDiscreteAttribute", "GsaUpdateDiscreteFunctionalAttribute", @@ -3154,8 +2117,7 @@ "GsaUpdateDiscreteParameterValue", "GsaUpdateDiscreteRange", "GsaUpdateDiscreteType", - "GsaUpdateDisplayNames", - "GsaUpdateDisplayNamesResponse", + "GsaUpdateDynamicRecordLinkGroup", "GsaUpdateExpression", "GsaUpdateFile", "GsaUpdateFileAttribute", @@ -3168,7 +2130,6 @@ "GsaUpdateIntegerAttribute", "GsaUpdateJobRequest", "GsaUpdateLayout", - "GsaUpdateLayoutSection", "GsaUpdateLinkedAttributeTabularColumn", "GsaUpdateLinkedColumnTabularColumn", "GsaUpdateLinkedRecordTabularColumn", @@ -3193,28 +2154,16 @@ "GsaUpdateParameter", "GsaUpdateParameterContent", "GsaUpdateParameterValue", - "GsaUpdatePermission", - "GsaUpdatePermissionAccessControl", - "GsaUpdatePermissionBasedAccessControl", - "GsaUpdatePermissionCategory", - "GsaUpdatePermissionCategoryAccessControl", - "GsaUpdatePermissionCategoryAccessControlRequest", "GsaUpdatePictureAttribute", "GsaUpdatePointAttribute", "GsaUpdateProfile", "GsaUpdateProfileTable", - "GsaUpdatePutLayoutItem", - "GsaUpdatePutPermission", - "GsaUpdatePutPermissionCategory", "GsaUpdateRangeAttribute", "GsaUpdateRecordLinkGroup", "GsaUpdateRecordListPermissionFlags", "GsaUpdateRecordListProperties", "GsaUpdateReplacementString", - "GsaUpdateRootFolderErrorDetail", - "GsaUpdateRunStatus", "GsaUpdateShortTextAttribute", - "GsaUpdateSmartRecordLinkGroup", "GsaUpdateStandardName", "GsaUpdateStaticRecordLinkGroup", "GsaUpdateSubset", @@ -3227,16 +2176,12 @@ "GsaUpdateUnitSystem", "GsaUpdateUserPermission", "GsaUpdateUserPermissionsInfo", - "GsaUpgradeDatabaseException", - "GsaUpgradeDatabaseFailureReason", "GsaUsageDataModificationErrorDetail", + "GsaUserOrGroup", "GsaUserPermission", "GsaUserPermissionsInfo", "GsaUserRole", "GsaValidateAttributeRequest", - "GsaValidateUnitEquationRequest", - "GsaValidateUnitEquationResponse", - "GsaValueNotProvidedParameterValueErrorDetail", "GsaValueSpecifier", "GsaValueSpecifierType", "GsaValueWithCountOfBoolean", @@ -3247,12 +2192,8 @@ "GsaVersionNumberProperty", "GsaVersionState", "GsaVersionStateProperty", - "GsaWeightingType", "GsaWithdrawRecordVersionControlException", - "GsaXYChartTemplate", "GsaXYChartTemplateUsageDataModificationErrorDetail", - "GsaXYChartTemplatesInfo", - "GsaXYTemplateAxis", "JobqueueFilesBody", "JsonPatchDocument", "MicrosoftAspNetCoreMvcFormattersIOutputFormatter", diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/__init__.py index 32d85c045..3a9d33cbb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/__init__.py @@ -25,24 +25,12 @@ # import API ABC from ansys.openapi.common import ApiBase -from .access_control___attribute_based_categories_api import ( - AccessControlAttributeBasedCategoriesApi, -) -from .access_control___permission_based_schema_api import AccessControlPermissionBasedSchemaApi - # import apis into api package -from .access_control_api import AccessControlApi -from .activity_log_api import ActivityLogApi from .aggregation_api import AggregationApi -from .blob_infos_api import BlobInfosApi -from .blobs_api import BlobsApi from .bulk_api import BulkApi -from .currencies_api import CurrenciesApi from .data_api import DataApi from .data_export_api import DataExportApi -from .data_updater_api import DataUpdaterApi from .database_api import DatabaseApi -from .find_similar_api import FindSimilarApi from .graph_api import GraphApi from .help_location_api import HelpLocationApi from .identities_api import IdentitiesApi @@ -54,7 +42,7 @@ from .list_management_api import ListManagementApi from .list_permissions_api import ListPermissionsApi from .metrics_api import MetricsApi -from .record_links_api import RecordLinksApi +from .permission_based_access_control_api import PermissionBasedAccessControlApi from .records___record_histories_api import RecordsRecordHistoriesApi from .records___record_versions_api import RecordsRecordVersionsApi from .schema___attributes_api import SchemaAttributesApi @@ -64,7 +52,6 @@ from .schema___databases_api import SchemaDatabasesApi from .schema___discrete_types___discrete_values_api import SchemaDiscreteTypesDiscreteValuesApi from .schema___discrete_types_api import SchemaDiscreteTypesApi -from .schema___display_names_api import SchemaDisplayNamesApi from .schema___exporters_api import SchemaExportersApi from .schema___expressions_api import SchemaExpressionsApi from .schema___global_standard_names_api import SchemaGlobalStandardNamesApi @@ -75,38 +62,25 @@ from .schema___parameters_api import SchemaParametersApi from .schema___profile_tables_api import SchemaProfileTablesApi from .schema___profiles_api import SchemaProfilesApi -from .schema___quality_systems_api import SchemaQualitySystemsApi from .schema___record_link_groups_api import SchemaRecordLinkGroupsApi from .schema___replacement_strings_api import SchemaReplacementStringsApi -from .schema___search_masks_api import SchemaSearchMasksApi -from .schema___search_templates_api import SchemaSearchTemplatesApi -from .schema___security_groups_api import SchemaSecurityGroupsApi from .schema___standard_names_api import SchemaStandardNamesApi from .schema___subsets_api import SchemaSubsetsApi from .schema___tables_api import SchemaTablesApi -from .schema___unit_equivalents_api import SchemaUnitEquivalentsApi from .schema___units_api import SchemaUnitsApi -from .schema___xy_chart_templates_api import SchemaXYChartTemplatesApi from .schema_api import SchemaApi from .search_api import SearchApi +from .selection_searches_api import SelectionSearchesApi +from .server_manager_api import ServerManagerApi from .status_api import StatusApi __all__ = [ "ApiBase", - "AccessControlApi", - "AccessControlAttributeBasedCategoriesApi", - "AccessControlPermissionBasedSchemaApi", - "ActivityLogApi", "AggregationApi", - "BlobInfosApi", - "BlobsApi", "BulkApi", - "CurrenciesApi", "DataApi", "DataExportApi", - "DataUpdaterApi", "DatabaseApi", - "FindSimilarApi", "GraphApi", "HelpLocationApi", "IdentitiesApi", @@ -118,7 +92,7 @@ "ListManagementApi", "ListPermissionsApi", "MetricsApi", - "RecordLinksApi", + "PermissionBasedAccessControlApi", "RecordsRecordHistoriesApi", "RecordsRecordVersionsApi", "SchemaApi", @@ -129,7 +103,6 @@ "SchemaDatabasesApi", "SchemaDiscreteTypesDiscreteValuesApi", "SchemaDiscreteTypesApi", - "SchemaDisplayNamesApi", "SchemaExportersApi", "SchemaExpressionsApi", "SchemaGlobalStandardNamesApi", @@ -140,18 +113,14 @@ "SchemaParametersApi", "SchemaProfileTablesApi", "SchemaProfilesApi", - "SchemaQualitySystemsApi", "SchemaRecordLinkGroupsApi", "SchemaReplacementStringsApi", - "SchemaSearchMasksApi", - "SchemaSearchTemplatesApi", - "SchemaSecurityGroupsApi", "SchemaStandardNamesApi", "SchemaSubsetsApi", "SchemaTablesApi", - "SchemaUnitEquivalentsApi", "SchemaUnitsApi", - "SchemaXYChartTemplatesApi", "SearchApi", + "SelectionSearchesApi", + "ServerManagerApi", "StatusApi", ] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___permission_based_schema_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___permission_based_schema_api.py deleted file mode 100644 index db733b94f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___permission_based_schema_api.py +++ /dev/null @@ -1,1171 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlPermissionBasedSchemaApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def create_permission( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaCreatePermission]" = None, - ) -> "GsaPermission | GsaPermissionCreationException | None": - """Create a new permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - body: GsaCreatePermission - - Returns - ------- - GsaPermission | GsaPermissionCreationException | None - """ - data = self._create_permission_with_http_info( - database_key, category_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_permission_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaCreatePermission]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'create_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 201: "GsaPermission", - 400: "GsaPermissionCreationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_permission_category( - self, *, database_key: "str", body: "Optional[GsaCreatePermissionCategory]" = None - ) -> "GsaPermissionCategory | GsaPermissionCategoryCreationException | None": - """Create a new permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaCreatePermissionCategory - - Returns - ------- - GsaPermissionCategory | GsaPermissionCategoryCreationException | None - """ - data = self._create_permission_category_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_permission_category_with_http_info( - self, - database_key: "str", - body: "Optional[GsaCreatePermissionCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 201: "GsaPermissionCategory", - 400: "GsaPermissionCategoryCreationException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_permission( - self, *, database_key: "str", category_guid: "str", permission_guid: "str" - ) -> "GsaPermissionDeletionException | None": - """Delete a permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - - Returns - ------- - GsaPermissionDeletionException | None - """ - data = self._delete_permission_with_http_info( - database_key, category_guid, permission_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_permission_with_http_info( - self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_permission'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'delete_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 400: "GsaPermissionDeletionException", - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_permission_category(self, *, database_key: "str", category_guid: "str") -> "None": - """Delete a permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - None - """ - data = self._delete_permission_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_permission_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_categories( - self, *, database_key: "str" - ) -> "GsaPermissionCategoriesInfo | None": - """Get all permission-based access control categories for the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaPermissionCategoriesInfo | None - """ - data = self._get_permission_categories_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoriesInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_category( - self, *, database_key: "str", category_guid: "str" - ) -> "GsaPermissionCategory | None": - """Get a permission-based access control category with a specified guid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - GsaPermissionCategory | None - """ - data = self._get_permission_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategory", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permission_in_category( - self, *, database_key: "str", category_guid: "str", permission_guid: "str" - ) -> "GsaPermission | None": - """Get a permission-based access control permission with a given guid in the specified category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - - Returns - ------- - GsaPermission | None - """ - data = self._get_permission_in_category_with_http_info( - database_key, category_guid, permission_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permission_in_category_with_http_info( - self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permission_in_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permission_in_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permission_in_category'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'get_permission_in_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermission", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_permissions_in_category( - self, *, database_key: "str", category_guid: "str" - ) -> "GsaPermissionsInfo | None": - """Get all permission-based access control permissions for the specified category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - - Returns - ------- - GsaPermissionsInfo | None - """ - data = self._get_permissions_in_category_with_http_info( - database_key, category_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_permissions_in_category_with_http_info( - self, database_key: "str", category_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_permissions_in_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_permissions_in_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_permissions_in_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionsInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def replace_permission_categories( - self, *, database_key: "str", body: "Optional[GsaReplacePermissionCategoriesRequest]" = None - ) -> "GsaPermissionCategoriesInfo | GsaPermissionCategoryReplaceException | None": - """Replace all permission-based access control categories. This can result in adding, modifying and deleting permission categories. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaReplacePermissionCategoriesRequest - - Returns - ------- - GsaPermissionCategoriesInfo | GsaPermissionCategoryReplaceException | None - """ - data = self._replace_permission_categories_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _replace_permission_categories_with_http_info( - self, - database_key: "str", - body: "Optional[GsaReplacePermissionCategoriesRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method replace_permission_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'replace_permission_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoriesInfo", - 400: "GsaPermissionCategoryReplaceException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_permission( - self, - *, - database_key: "str", - category_guid: "str", - permission_guid: "str", - body: "Optional[GsaUpdatePermission]" = None, - ) -> "GsaPermission | GsaPermissionUpdateException | None": - """Update a permission-based access control permission. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - permission_guid: str - See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory) - body: GsaUpdatePermission - - Returns - ------- - GsaPermission | GsaPermissionUpdateException | None - """ - data = self._update_permission_with_http_info( - database_key, category_guid, permission_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_permission_with_http_info( - self, - database_key: "str", - category_guid: "str", - permission_guid: "str", - body: "Optional[GsaUpdatePermission]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "permission_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_permission" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_permission'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_permission'" - ) - # verify the required parameter "permission_guid" is set - if "permission_guid" not in params or params["permission_guid"] is None: - raise ValueError( - "Missing the required parameter 'permission_guid' when calling 'update_permission'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - if "permission_guid" in params and permission_guid is not None: - path_params["permission-guid"] = params["permission_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermission", - 400: "GsaPermissionUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_permission_category( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdatePermissionCategory]" = None, - ) -> "GsaPermissionCategory | GsaPermissionCategoryUpdateException | None": - """Update a permission-based access control category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - category_guid: str - See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories) - body: GsaUpdatePermissionCategory - - Returns - ------- - GsaPermissionCategory | GsaPermissionCategoryUpdateException | None - """ - data = self._update_permission_category_with_http_info( - database_key, category_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_permission_category_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdatePermissionCategory]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "category_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_permission_category" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_permission_category'" - ) - # verify the required parameter "category_guid" is set - if "category_guid" not in params or params["category_guid"] is None: - raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_permission_category'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "category_guid" in params and category_guid is not None: - path_params["category-guid"] = params["category_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategory", - 400: "GsaPermissionCategoryUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control_api.py deleted file mode 100644 index bf1e67e3a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control_api.py +++ /dev/null @@ -1,109 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class AccessControlApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_current_access_control_mode(self) -> "GsaAccessControlModeInfo | None": - """Gets the information about current access control mode. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaAccessControlModeInfo | None - """ - data = self._get_current_access_control_mode_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_current_access_control_mode_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_current_access_control_mode" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlModeInfo", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/accessControl/currentMode", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/activity_log_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/activity_log_api.py deleted file mode 100644 index db5edeedc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/activity_log_api.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class ActivityLogApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_entries( - self, - *, - body: "Optional[GsaActivityLogEntriesFilter]" = None, - page_size: "Optional[int]" = 1000, - page: "Optional[int]" = 1, - ) -> "GsaActivityLogEntriesInfo | None": - """Get filtered activity log entries, ordered from newest to oldest. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaActivityLogEntriesFilter - Filter object used to narrow down the entries to return. - page_size: int - Page size. Defaults to 1 000. The limit is 10 000. - page: int - Page number. Defaults to 1. - - Returns - ------- - GsaActivityLogEntriesInfo | None - """ - data = self._get_entries_with_http_info(body, page_size, page, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_entries_with_http_info( - self, - body: "Optional[GsaActivityLogEntriesFilter]" = None, - page_size: "Optional[int]" = 1000, - page: "Optional[int]" = 1, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "page_size", - "page", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_entries") - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - if "page_size" in params and page_size is not None: - query_params.append(("pageSize", params["page_size"])) - if "page" in params and page is not None: - query_params.append(("page", params["page"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaActivityLogEntriesInfo", - 400: None, - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/activity-log/entries", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/aggregation_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/aggregation_api.py index c1a30c9e0..bc5a4ee21 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/aggregation_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/aggregation_api.py @@ -63,7 +63,6 @@ def database_aggregation( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaAggregationsRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -178,9 +177,7 @@ def database_aggregation_for_table_with_guid( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaAggregationsRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -304,7 +301,6 @@ def database_aggregation_for_table_with_identity( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int body: GsaAggregationsRequest x_ansys_vc_mode: str diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blob_infos_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blob_infos_api.py deleted file mode 100644 index 26b5aa499..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blob_infos_api.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class BlobInfosApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_all_data_updater_blob_infos(self) -> "list[GsaBlobInfoDto]": - """Get a list of all blob descriptors for databases that the user is admin of. - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaBlobInfoDto] - """ - data = self._get_all_data_updater_blob_infos_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_data_updater_blob_infos_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_data_updater_blob_infos" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaBlobInfoDto]", - } - - return self.api_client.call_api( - "/v1alpha/blob-infos/dataupdater", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_blob_infos( - self, *, database_key: "str", blob_path: "str", recursive: "Optional[bool]" = None - ) -> "list[GsaBlobInfoDto]": - """Get a list of blob descriptors for a specific database, optionally limited by their relative path. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key. - blob_path: str - Path to look under (without the blob name). Can be empty - recursive: bool - Whether to look under sub-paths as well. - - Returns - ------- - list[GsaBlobInfoDto] - """ - data = self._get_data_updater_blob_infos_with_http_info( - database_key, blob_path, recursive, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_data_updater_blob_infos_with_http_info( - self, - database_key: "str", - blob_path: "str", - recursive: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "recursive", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_blob_infos" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_data_updater_blob_infos'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'get_data_updater_blob_infos'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blob-path"] = params["blob_path"] - - query_params: list[Any] = [] - if "recursive" in params and recursive is not None: - query_params.append(("recursive", params["recursive"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaBlobInfoDto]", - } - - return self.api_client.call_api( - "/v1alpha/blob-infos/dataupdater/{database-key}/{blob-path}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blobs_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blobs_api.py deleted file mode 100644 index 61042b865..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/blobs_api.py +++ /dev/null @@ -1,336 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class BlobsApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def delete_data_updater_blob(self, *, database_key: "str", blob_path: "str") -> "None": - """Delete DataUpdater blob. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - - Returns - ------- - None - """ - data = self._delete_data_updater_blob_with_http_info( - database_key, blob_path, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_data_updater_blob_with_http_info( - self, database_key: "str", blob_path: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'delete_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def download_data_updater_blob(self, *, database_key: "str", blob_path: "str") -> "None": - """Retrieve DataUpdater blob contents by its path. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - - Returns - ------- - None - """ - data = self._download_data_updater_blob_with_http_info( - database_key, blob_path, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _download_data_updater_blob_with_http_info( - self, database_key: "str", blob_path: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method download_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'download_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'download_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def upload_data_updater_blob( - self, - *, - database_key: "str", - blob_path: "str", - body: "Optional[BinaryIO | pathlib.Path]" = None, - ) -> "GsaBlobInfoDto": - """Store DataUpdater blob contents. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - Database key - blob_path: str - Blob path to a single blob (including its name). - body: BinaryIO | pathlib.Path - - Returns - ------- - GsaBlobInfoDto - """ - data = self._upload_data_updater_blob_with_http_info( - database_key, blob_path, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _upload_data_updater_blob_with_http_info( - self, - database_key: "str", - blob_path: "str", - body: "Optional[BinaryIO | pathlib.Path]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "blob_path", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method upload_data_updater_blob" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'upload_data_updater_blob'" - ) - # verify the required parameter "blob_path" is set - if "blob_path" not in params or params["blob_path"] is None: - raise ValueError( - "Missing the required parameter 'blob_path' when calling 'upload_data_updater_blob'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "blob_path" in params and blob_path is not None: - path_params["blobPath"] = params["blob_path"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/octet-stream", "application/zip"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaBlobInfoDto", - } - - return self.api_client.call_api( - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_api.py index d1616590e..5b4c7f8b6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_api.py @@ -63,10 +63,8 @@ def append_values_for_discrete_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendDiscreteValues Returns @@ -187,12 +185,9 @@ def append_values_for_discrete_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendDiscreteValues Returns @@ -326,10 +321,8 @@ def append_values_for_point_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendPointValues Returns @@ -450,12 +443,9 @@ def append_values_for_point_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaAppendPointValues Returns @@ -590,10 +580,8 @@ def delete_cell_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str @@ -727,12 +715,9 @@ def delete_cell_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str @@ -869,10 +854,8 @@ def delete_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -975,12 +958,9 @@ def delete_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -1103,10 +1083,8 @@ def export_binary_data_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1250,12 +1228,9 @@ def export_binary_data_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1409,11 +1384,9 @@ def export_binary_data_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1568,13 +1541,10 @@ def export_binary_data_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1739,10 +1709,8 @@ def export_cell_binary_data_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -1910,12 +1878,9 @@ def export_cell_binary_data_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2093,11 +2058,9 @@ def export_cell_binary_data_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2276,13 +2239,10 @@ def export_cell_binary_data_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2467,10 +2427,8 @@ def get_cell_datum_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2621,12 +2579,9 @@ def get_cell_datum_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2787,11 +2742,9 @@ def get_cell_datum_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -2953,13 +2906,10 @@ def get_cell_datum_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str mode: str @@ -3129,10 +3079,8 @@ def get_datum_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -3273,12 +3221,9 @@ def get_datum_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -3429,11 +3374,9 @@ def get_datum_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -3585,13 +3528,10 @@ def get_datum_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -3750,10 +3690,8 @@ def set_cell_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str body: GsaSetDatum @@ -3902,12 +3840,9 @@ def set_cell_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str body: GsaSetDatum @@ -4068,10 +4003,8 @@ def set_cell_file_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str file: BinaryIO | pathlib.Path @@ -4239,12 +4172,9 @@ def set_cell_file_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str file: BinaryIO | pathlib.Path @@ -4418,10 +4348,8 @@ def set_cell_picture_datum_for_tabular_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str picture: BinaryIO | pathlib.Path @@ -4569,12 +4497,9 @@ def set_cell_picture_datum_for_tabular_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) row_guid: str column_guid: str picture: BinaryIO | pathlib.Path @@ -4729,10 +4654,8 @@ def set_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaSetDatum Returns @@ -4854,12 +4777,9 @@ def set_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaSetDatum Returns @@ -4989,10 +4909,8 @@ def set_datum_not_applicable( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -5095,12 +5013,9 @@ def set_datum_not_applicable_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -5223,10 +5138,8 @@ def set_file_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) file: BinaryIO | pathlib.Path description: str target: str @@ -5370,12 +5283,9 @@ def set_file_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) file: BinaryIO | pathlib.Path description: str target: str @@ -5525,10 +5435,8 @@ def set_picture_datum_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) picture: BinaryIO | pathlib.Path Returns @@ -5648,12 +5556,9 @@ def set_picture_datum_for_attribute_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) picture: BinaryIO | pathlib.Path Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_export_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_export_api.py index 3dbbf54d9..07a3478cc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_export_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_export_api.py @@ -63,7 +63,6 @@ def export_data( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaDataExportRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_updater_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_updater_api.py deleted file mode 100644 index 54cb85b39..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/data_updater_api.py +++ /dev/null @@ -1,1580 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class DataUpdaterApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def apply_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start an apply job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._apply_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _apply_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method apply_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'apply_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'apply_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:apply", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_or_update_project( - self, - *, - database_key: "str", - project_id: "str", - body: "Optional[GsaDataUpdaterProject]" = None, - ) -> "None": - """Creates a new project or updates an existing one. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - body: GsaDataUpdaterProject - - Returns - ------- - None - """ - data = self._create_or_update_project_with_http_info( - database_key, project_id, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_or_update_project_with_http_info( - self, - database_key: "str", - project_id: "str", - body: "Optional[GsaDataUpdaterProject]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "project_id", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_or_update_project" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_or_update_project'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'create_or_update_project'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "PUT", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def create_update( - self, - *, - database_key: "str", - project_id: "str", - body: "Optional[GsaCreateDataUpdateServerApiRequest]" = None, - ) -> "str": - """Creates and queues a new 'create update' job for a given project. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - body: GsaCreateDataUpdateServerApiRequest - - Returns - ------- - str - """ - data = self._create_update_with_http_info( - database_key, project_id, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _create_update_with_http_info( - self, - database_key: "str", - project_id: "str", - body: "Optional[GsaCreateDataUpdateServerApiRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "project_id", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_update'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'create_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_completed_data_updater_job(self, *, job_id: "str") -> "None": - """Delete a specific job. Only valid if job is in one of the completed states. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - job_id: str - - Returns - ------- - None - """ - data = self._delete_completed_data_updater_job_with_http_info( - job_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_completed_data_updater_job_with_http_info( - self, job_id: "str", **kwargs: Any - ) -> Any: - all_params = ["job_id", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_completed_data_updater_job" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "job_id" is set - if "job_id" not in params or params["job_id"] is None: - raise ValueError( - "Missing the required parameter 'job_id' when calling 'delete_completed_data_updater_job'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "job_id" in params and job_id is not None: - path_params["job-id"] = params["job_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs/{job-id}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_project(self, *, database_key: "str", project_id: "str") -> "None": - """Deletes a project. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - project_id: str - - Returns - ------- - None - """ - data = self._delete_project_with_http_info( - database_key, project_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_project_with_http_info( - self, database_key: "str", project_id: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "project_id", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_project" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_project'" - ) - # verify the required parameter "project_id" is set - if "project_id" not in params or params["project_id"] is None: - raise ValueError( - "Missing the required parameter 'project_id' when calling 'delete_project'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "project_id" in params and project_id is not None: - path_params["project-id"] = params["project_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}/{project-id}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def delete_update(self, *, database_key: "str", update_token_guid: "str") -> "None": - """Deletes an update if it is in a deletable state. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - None - """ - data = self._delete_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'delete_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def dry_run_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start a dry run job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._dry_run_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _dry_run_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method dry_run_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'dry_run_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'dry_run_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:dry-run", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def fill_in_fallback_identifiers(self, *, database_key: "str") -> "None": - """Starts a long-running operation of generating fallback identifiers for a given database. Returns immediately. User is expected to watch MI Server logs for progress and errors. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - None - """ - data = self._fill_in_fallback_identifiers_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _fill_in_fallback_identifiers_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method fill_in_fallback_identifiers" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'fill_in_fallback_identifiers'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}:fill-in-fallback-ids", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def finalize_update(self, *, database_key: "str", update_token_guid: "str") -> "str": - """Start a finalize job for a given update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - str - """ - data = self._finalize_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _finalize_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method finalize_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'finalize_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'finalize_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:finalize", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_all_updates(self) -> "list[GsaDataUpdate]": - """get_all_updates - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaDataUpdate] - """ - data = self._get_all_updates_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_updates_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_updates" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdate]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_job(self, *, job_id: "str") -> "GsaDataUpdaterJob": - """Get a specific job. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - job_id: str - - Returns - ------- - GsaDataUpdaterJob - """ - data = self._get_data_updater_job_with_http_info(job_id, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_data_updater_job_with_http_info(self, job_id: "str", **kwargs: Any) -> Any: - all_params = ["job_id", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_job" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "job_id" is set - if "job_id" not in params or params["job_id"] is None: - raise ValueError( - "Missing the required parameter 'job_id' when calling 'get_data_updater_job'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "job_id" in params and job_id is not None: - path_params["job-id"] = params["job_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdaterJob", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs/{job-id}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_data_updater_jobs(self) -> "list[GsaDataUpdaterJob]": - """Get all jobs. (pertaining to databases that the user is administrator of) - - This method makes a synchronous HTTP request. - - Returns - ------- - list[GsaDataUpdaterJob] - """ - data = self._get_data_updater_jobs_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_data_updater_jobs_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_data_updater_jobs" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdaterJob]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/jobs", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_projects_for_database(self, *, database_key: "str") -> "list[GsaDataUpdaterProject]": - """get_projects_for_database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - list[GsaDataUpdaterProject] - """ - data = self._get_projects_for_database_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_projects_for_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_projects_for_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_projects_for_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdaterProject]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/projects/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_selection(self, *, database_key: "str", profile_id: "str") -> "GsaSelection": - """Retrieves selection based on profile and database key - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - profile_id: str - - Returns - ------- - GsaSelection - """ - data = self._get_selection_with_http_info( - database_key, profile_id, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_selection_with_http_info( - self, database_key: "str", profile_id: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "profile_id", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_selection" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_selection'" - ) - # verify the required parameter "profile_id" is set - if "profile_id" not in params or params["profile_id"] is None: - raise ValueError( - "Missing the required parameter 'profile_id' when calling 'get_selection'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "profile_id" in params and profile_id is not None: - path_params["profile-id"] = params["profile_id"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSelection", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/profiles/{profile-id}/selections/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_update(self, *, database_key: "str", update_token_guid: "str") -> "GsaDataUpdate": - """Get registered update. Retrieves info about an update that was registered by the Apply side. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - GsaDataUpdate - """ - data = self._get_update_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_update_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_update") - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_update'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'get_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdate", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_update_header( - self, *, database_key: "str", update_token_guid: "str" - ) -> "GsaDataUpdateHeader": - """Get update header from update file. Works even for unregistered updates (i.e. ones just created by the Create side). - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - update_token_guid: str - - Returns - ------- - GsaDataUpdateHeader - """ - data = self._get_update_header_with_http_info( - database_key, update_token_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_update_header_with_http_info( - self, database_key: "str", update_token_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "update_token_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_update_header" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_update_header'" - ) - # verify the required parameter "update_token_guid" is set - if "update_token_guid" not in params or params["update_token_guid"] is None: - raise ValueError( - "Missing the required parameter 'update_token_guid' when calling 'get_update_header'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "update_token_guid" in params and update_token_guid is not None: - path_params["update-token-guid"] = params["update_token_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdateHeader", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}/header", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_updates_for_database(self, *, database_key: "str") -> "list[GsaDataUpdate]": - """get_updates_for_database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - list[GsaDataUpdate] - """ - data = self._get_updates_for_database_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_updates_for_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_updates_for_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_updates_for_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "list[GsaDataUpdate]", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def register_update( - self, *, database_key: "str", body: "Optional[GsaRegisterUpdateRequest]" = None - ) -> "GsaDataUpdateToken": - """Register an update - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaRegisterUpdateRequest - - Returns - ------- - GsaDataUpdateToken - """ - data = self._register_update_with_http_info(database_key, body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _register_update_with_http_info( - self, database_key: "str", body: "Optional[GsaRegisterUpdateRequest]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method register_update" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'register_update'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataUpdateToken", - } - - return self.api_client.call_api( - "/v1alpha/dataupdater/updates/{database-key}", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/database_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/database_api.py index 7b88cde60..df2dffc3e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/database_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/database_api.py @@ -825,7 +825,7 @@ def _generate_schema_from_table_name_with_http_info( def get_search_index_status( self, *, database_key: "str", include_errors: "Optional[bool]" = None ) -> "GsaSearchIndexStatus | None": - """GetSearch Index Status for a given database + """Get Search Index Status for a given database This method makes a synchronous HTTP request. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/find_similar_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/find_similar_api.py deleted file mode 100644 index abbfc5d3d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/find_similar_api.py +++ /dev/null @@ -1,462 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class FindSimilarApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def delete_find_similar_results(self, *, find_similar_identifier: "str") -> "None": - """Delete find similar results by identifier - - This method makes a synchronous HTTP request. - - Parameters - ---------- - find_similar_identifier: str - - Returns - ------- - None - """ - data = self._delete_find_similar_results_with_http_info( - find_similar_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _delete_find_similar_results_with_http_info( - self, find_similar_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "find_similar_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_find_similar_results" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "find_similar_identifier" is set - if "find_similar_identifier" not in params or params["find_similar_identifier"] is None: - raise ValueError( - "Missing the required parameter 'find_similar_identifier' when calling 'delete_find_similar_results'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "find_similar_identifier" in params and find_similar_identifier is not None: - path_params["find-similar-identifier"] = params["find_similar_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/{find-similar-identifier}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def find_similar( - self, - *, - database_key: "str", - table_guid: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "str": - """Finds similar records in a given database and table for a given record - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_guid: str - body: GsaFindSimilarRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - str - """ - data = self._find_similar_with_http_info( - database_key, - table_guid, - record_guid, - body, - x_ansys_vc_mode, - mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _find_similar_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_guid", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method find_similar" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'find_similar'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'find_similar'" - ) - # verify the required parameter "record_guid" is set - if "record_guid" not in params or params["record_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_guid' when calling 'find_similar'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_guid" in params and record_guid is not None: - path_params["record-guid"] = params["record_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record/{record-guid}:findsimilar", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_find_similar_results( - self, *, find_similar_identifier: "str" - ) -> "GsaFindSimilarResponse | None": - """Returns find similar results by identifier - - This method makes a synchronous HTTP request. - - Parameters - ---------- - find_similar_identifier: str - - Returns - ------- - GsaFindSimilarResponse | None - """ - data = self._get_find_similar_results_with_http_info( - find_similar_identifier, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_find_similar_results_with_http_info( - self, find_similar_identifier: "str", **kwargs: Any - ) -> Any: - all_params = [ - "find_similar_identifier", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_find_similar_results" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "find_similar_identifier" is set - if "find_similar_identifier" not in params or params["find_similar_identifier"] is None: - raise ValueError( - "Missing the required parameter 'find_similar_identifier' when calling 'get_find_similar_results'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "find_similar_identifier" in params and find_similar_identifier is not None: - path_params["find-similar-identifier"] = params["find_similar_identifier"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFindSimilarResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/{find-similar-identifier}/results", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def integration_find_similar( - self, *, schema: "str", record_guid: "str", body: "Optional[GsaFindSimilarRequest]" = None - ) -> "None | str": - """Runs a find similar calculation against the integration schema. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - schema: str - record_guid: str - body: GsaFindSimilarRequest - - Returns - ------- - None | str - """ - data = self._integration_find_similar_with_http_info( - schema, record_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _integration_find_similar_with_http_info( - self, - schema: "str", - record_guid: "str", - body: "Optional[GsaFindSimilarRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "schema", - "record_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method integration_find_similar" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "schema" is set - if "schema" not in params or params["schema"] is None: - raise ValueError( - "Missing the required parameter 'schema' when calling 'integration_find_similar'" - ) - # verify the required parameter "record_guid" is set - if "record_guid" not in params or params["record_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_guid' when calling 'integration_find_similar'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "schema" in params and schema is not None: - path_params["schema"] = params["schema"] - if "record_guid" in params and record_guid is not None: - path_params["record-guid"] = params["record_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "str", - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/integration-schemas/{schema}/record/{record-guid}:findsimilar", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/graph_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/graph_api.py index 6e10e765e..87d44f99e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/graph_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/graph_api.py @@ -66,11 +66,9 @@ def evaluate_graph_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -221,13 +219,10 @@ def evaluate_graph_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -386,10 +381,8 @@ def evaluate_graph_value_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -529,12 +522,9 @@ def evaluate_graph_value_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaGraphEvaluationSettings x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -682,10 +672,8 @@ def get_graph_for_latest( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -813,12 +801,9 @@ def get_graph_for_latest_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -956,11 +941,9 @@ def get_graph_for_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1099,13 +1082,10 @@ def get_graph_for_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/identities_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/identities_api.py index 76d95bc18..ce7f6312e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/identities_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/identities_api.py @@ -54,7 +54,7 @@ def translate_guids_to_identities( body: "Optional[GsaTranslateGuidsToIdentitiesRequest]" = None, x_ansys_vc_mode: "Optional[str]" = None, mode: "Optional[str]" = None, - ) -> "GsaTranslateBetweenGuidsAndIdentitiesResponse | None": + ) -> "GsaTranslateGuidsToIdentitiesResponse | None": """For internal use only. Translates guids to identities. This method makes a synchronous HTTP request. @@ -69,7 +69,7 @@ def translate_guids_to_identities( Returns ------- - GsaTranslateBetweenGuidsAndIdentitiesResponse | None + GsaTranslateGuidsToIdentitiesResponse | None """ data = self._translate_guids_to_identities_with_http_info( body, x_ansys_vc_mode, mode, _return_http_data_only=True @@ -128,7 +128,7 @@ def _translate_guids_to_identities_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaTranslateBetweenGuidsAndIdentitiesResponse", + 200: "GsaTranslateGuidsToIdentitiesResponse", 400: None, } @@ -147,103 +147,3 @@ def _translate_guids_to_identities_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def translate_identities_to_guids( - self, - *, - body: "Optional[GsaTranslateIdentitiesToGuidsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaTranslateBetweenGuidsAndIdentitiesResponse | None": - """For internal use only. Translates identities to GUIDs. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaTranslateIdentitiesToGuidsRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaTranslateBetweenGuidsAndIdentitiesResponse | None - """ - data = self._translate_identities_to_guids_with_http_info( - body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _translate_identities_to_guids_with_http_info( - self, - body: "Optional[GsaTranslateIdentitiesToGuidsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method translate_identities_to_guids" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaTranslateBetweenGuidsAndIdentitiesResponse", - 400: None, - } - - return self.api_client.call_api( - "/v1alpha/guids", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/integration_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/integration_api.py index fe625ff77..54c02a9d5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/integration_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/integration_api.py @@ -460,7 +460,6 @@ def schema_table_mappings( ---------- schema: str database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/license_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/license_api.py index ca4c9581d..2d24e13f5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/license_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/license_api.py @@ -124,72 +124,6 @@ def _checkout_app_license_with_http_info( response_type_map=response_type_map, ) - def ensure_advanced_selection_license_available( - self, - ) -> "MicrosoftAspNetCoreMvcObjectResult | None": - """Determines whether the requesting user has an Advanced Selection license available. If a user has a license available this will be checked out. - - This method makes a synchronous HTTP request. - - Returns - ------- - MicrosoftAspNetCoreMvcObjectResult | None - """ - data = self._ensure_advanced_selection_license_available_with_http_info( - _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _ensure_advanced_selection_license_available_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method ensure_advanced_selection_license_available" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: "MicrosoftAspNetCoreMvcObjectResult", - } - - return self.api_client.call_api( - "/v1alpha/license/advanced-selection-license:ensure-checked-out", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def ensure_user_license_available(self) -> "MicrosoftAspNetCoreMvcObjectResult | None": """Either checks out a user license for the requesting user, or returns an error response if no such license is available. This method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/metrics_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/metrics_api.py index 1aaf20dbd..ce8801e27 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/metrics_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/metrics_api.py @@ -56,7 +56,6 @@ def get_jobs_summary(self, *, start: "Optional[str]" = None) -> "GsaGetJobsSumma Parameters ---------- start: str - The number of System.DateTime.Ticks that represent the UTC start time. Returns ------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___attribute_based_categories_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/permission_based_access_control_api.py similarity index 59% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___attribute_based_categories_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/permission_based_access_control_api.py index aa3fdd566..556e6bb72 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/access_control___attribute_based_categories_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/permission_based_access_control_api.py @@ -41,42 +41,36 @@ from ..models import * -class AccessControlAttributeBasedCategoriesApi(ApiBase): +class PermissionBasedAccessControlApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def create_category( - self, *, database_key: "str", body: "Optional[GsaCreateAccessControlCategory]" = None - ) -> "GsaAccessControlCategory | GsaAccessControlCategoryCreationException | None": - """Create an attribute-based access control category in the specified database. + def get_permission_categories( + self, *, database_key: "str" + ) -> "GsaPermissionCategoriesInfo | None": + """Get all permission-based access control categories for the specified database. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaCreateAccessControlCategory Returns ------- - GsaAccessControlCategory | GsaAccessControlCategoryCreationException | None + GsaPermissionCategoriesInfo | None """ - data = self._create_category_with_http_info(database_key, body, _return_http_data_only=True) + data = self._get_permission_categories_with_http_info( + database_key, _return_http_data_only=True + ) return data # type: ignore[no-any-return] - def _create_category_with_http_info( - self, - database_key: "str", - body: "Optional[GsaCreateAccessControlCategory]" = None, - **kwargs: Any, - ) -> Any: + def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", - "body", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -86,14 +80,14 @@ def _create_category_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method create_category" + f"Got an unexpected keyword argument '{key}' to method get_permission_categories" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'create_category'" + "Missing the required parameter 'database_key' when calling 'get_permission_categories'" ) collection_formats: dict[str, Any] = {} @@ -110,27 +104,19 @@ def _create_category_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - response_type_map: dict[int, Optional[str]] = { - 201: "GsaAccessControlCategory", - 400: "GsaAccessControlCategoryCreationException", + 200: "GsaPermissionCategoriesInfo", 403: None, 404: None, 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories", - "POST", + "/v1alpha/databases/{database-key}/permission-categories", + "GET", path_params, query_params, header_params, @@ -144,27 +130,28 @@ def _create_category_with_http_info( response_type_map=response_type_map, ) - def delete_category(self, *, database_key: "str", category_guid: "str") -> "None": - """Delete an attribute-based access control category in the specified database. + def get_permission_category( + self, *, database_key: "str", category_guid: "str" + ) -> "GsaPermissionCategory | None": + """Get a permission-based access control category with a specified guid. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) category_guid: str Returns ------- - None + GsaPermissionCategory | None """ - data = self._delete_category_with_http_info( + data = self._get_permission_category_with_http_info( database_key, category_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _delete_category_with_http_info( + def _get_permission_category_with_http_info( self, database_key: "str", category_guid: "str", **kwargs: Any ) -> Any: all_params = [ @@ -179,19 +166,19 @@ def _delete_category_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method delete_category" + f"Got an unexpected keyword argument '{key}' to method get_permission_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'delete_category'" + "Missing the required parameter 'database_key' when calling 'get_permission_category'" ) # verify the required parameter "category_guid" is set if "category_guid" not in params or params["category_guid"] is None: raise ValueError( - "Missing the required parameter 'category_guid' when calling 'delete_category'" + "Missing the required parameter 'category_guid' when calling 'get_permission_category'" ) collection_formats: dict[str, Any] = {} @@ -209,114 +196,19 @@ def _delete_category_with_http_info( form_params: list[Any] = [] local_var_files: dict[str, Any] = {} - body_params = None - - response_type_map: dict[int, Optional[str]] = { - 200: None, - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", - "DELETE", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_categories( - self, - *, - database_key: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - ) -> "GsaAccessControlCategoriesInfo | None": - """Get all access control categories for the specified database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - include: list[GsaAccessControlCategoryInclude] - Optionally include related data e.g. tableMappings in the response. - - Returns - ------- - GsaAccessControlCategoriesInfo | None - """ - data = self._get_categories_with_http_info( - database_key, include, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_categories_with_http_info( - self, - database_key: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "include", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_categories" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_categories'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - body_params = None # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategoriesInfo", + 200: "GsaPermissionCategory", 403: None, 404: None, 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}", "GET", path_params, query_params, @@ -331,45 +223,35 @@ def _get_categories_with_http_info( response_type_map=response_type_map, ) - def get_category_by_guid( - self, - *, - database_key: "str", - category_guid: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - ) -> "GsaAccessControlCategory | None": - """Get the access control category with the specified guid in the specified database. + def get_permission_in_category( + self, *, database_key: "str", category_guid: "str", permission_guid: "str" + ) -> "GsaPermission | None": + """Get a permission-based access control permission with a given guid in the specified category. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) category_guid: str - include: list[GsaAccessControlCategoryInclude] - Optionally include related data e.g. tableMappings in the response. + permission_guid: str Returns ------- - GsaAccessControlCategory | None + GsaPermission | None """ - data = self._get_category_by_guid_with_http_info( - database_key, category_guid, include, _return_http_data_only=True + data = self._get_permission_in_category_with_http_info( + database_key, category_guid, permission_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _get_category_by_guid_with_http_info( - self, - database_key: "str", - category_guid: "str", - include: "Optional[list[GsaAccessControlCategoryInclude]]" = None, - **kwargs: Any, + def _get_permission_in_category_with_http_info( + self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "category_guid", - "include", + "permission_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -379,19 +261,24 @@ def _get_category_by_guid_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_category_by_guid" + f"Got an unexpected keyword argument '{key}' to method get_permission_in_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_category_by_guid'" + "Missing the required parameter 'database_key' when calling 'get_permission_in_category'" ) # verify the required parameter "category_guid" is set if "category_guid" not in params or params["category_guid"] is None: raise ValueError( - "Missing the required parameter 'category_guid' when calling 'get_category_by_guid'" + "Missing the required parameter 'category_guid' when calling 'get_permission_in_category'" + ) + # verify the required parameter "permission_guid" is set + if "permission_guid" not in params or params["permission_guid"] is None: + raise ValueError( + "Missing the required parameter 'permission_guid' when calling 'get_permission_in_category'" ) collection_formats: dict[str, Any] = {} @@ -401,11 +288,10 @@ def _get_category_by_guid_with_http_info( path_params["database-key"] = params["database_key"] if "category_guid" in params and category_guid is not None: path_params["category-guid"] = params["category_guid"] + if "permission_guid" in params and permission_guid is not None: + path_params["permission-guid"] = params["permission_guid"] query_params: list[Any] = [] - if "include" in params and include is not None: - query_params.append(("include", params["include"])) - collection_formats["include"] = "multi" header_params: dict[str, Any] = {} @@ -417,14 +303,14 @@ def _get_category_by_guid_with_http_info( header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategory", + 200: "GsaPermission", 403: None, 404: None, 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}", "GET", path_params, query_params, @@ -439,44 +325,33 @@ def _get_category_by_guid_with_http_info( response_type_map=response_type_map, ) - def update_category( - self, - *, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdateAccessControlCategory]" = None, - ) -> "GsaAccessControlCategory | GsaAccessControlCategoryUpdateException | None": - """Update an attribute-based access control category in the specified database. + def get_permissions_in_category( + self, *, database_key: "str", category_guid: "str" + ) -> "GsaPermissionsInfo | None": + """Get all permission-based access control permissions for the specified category. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) category_guid: str - body: GsaUpdateAccessControlCategory Returns ------- - GsaAccessControlCategory | GsaAccessControlCategoryUpdateException | None + GsaPermissionsInfo | None """ - data = self._update_category_with_http_info( - database_key, category_guid, body, _return_http_data_only=True + data = self._get_permissions_in_category_with_http_info( + database_key, category_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _update_category_with_http_info( - self, - database_key: "str", - category_guid: "str", - body: "Optional[GsaUpdateAccessControlCategory]" = None, - **kwargs: Any, + def _get_permissions_in_category_with_http_info( + self, database_key: "str", category_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "category_guid", - "body", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -486,19 +361,19 @@ def _update_category_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_category" + f"Got an unexpected keyword argument '{key}' to method get_permissions_in_category" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_category'" + "Missing the required parameter 'database_key' when calling 'get_permissions_in_category'" ) # verify the required parameter "category_guid" is set if "category_guid" not in params or params["category_guid"] is None: raise ValueError( - "Missing the required parameter 'category_guid' when calling 'update_category'" + "Missing the required parameter 'category_guid' when calling 'get_permissions_in_category'" ) collection_formats: dict[str, Any] = {} @@ -517,27 +392,19 @@ def _update_category_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAccessControlCategory", - 400: "GsaAccessControlCategoryUpdateException", + 200: "GsaPermissionsInfo", 403: None, 404: None, 422: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}", - "PATCH", + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions", + "GET", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/record_links_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/record_links_api.py deleted file mode 100644 index 7acc57aac..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/record_links_api.py +++ /dev/null @@ -1,663 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class RecordLinksApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_link_results_for_group_for_history( - self, - *, - database_key: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for the latest version of a given record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - record_history_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_history_with_http_info( - database_key, - record_history_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_history_with_http_info( - self, - database_key: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "record_history_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_history" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_history'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_history'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_history_from_table( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for the latest version of a given record history in a given table for a given record link group. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_history_from_table_with_http_info( - database_key, - table_guid, - record_history_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_history_from_table_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_history_from_table" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_history_from_table'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_history_from_table'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_version( - self, - *, - database_key: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for a given record version of a given record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - record_history_guid: str - record_version_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_version_with_http_info( - database_key, - record_history_guid, - record_version_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_version_with_http_info( - self, - database_key: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "record_history_guid", - "record_version_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_version" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_version'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_version'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_link_results_for_group_for_version_from_table( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaRecordLinkResults | None": - """Get record link results for a given record version in a given table and record history for a given record link group - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - record_link_group_guid: str - record_link_group_type: str - The record link group type as entered. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaRecordLinkResults | None - """ - data = self._get_link_results_for_group_for_version_from_table_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - record_link_group_guid, - record_link_group_type, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_link_results_for_group_for_version_from_table_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - record_link_group_guid: "str", - record_link_group_type: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "record_link_group_guid", - "record_link_group_type", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_link_results_for_group_for_version_from_table" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_link_group_guid" is set - if "record_link_group_guid" not in params or params["record_link_group_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_guid' when calling 'get_link_results_for_group_for_version_from_table'" - ) - # verify the required parameter "record_link_group_type" is set - if "record_link_group_type" not in params or params["record_link_group_type"] is None: - raise ValueError( - "Missing the required parameter 'record_link_group_type' when calling 'get_link_results_for_group_for_version_from_table'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - if "record_link_group_guid" in params and record_link_group_guid is not None: - path_params["record-link-group-guid"] = params["record_link_group_guid"] - if "record_link_group_type" in params and record_link_group_type is not None: - path_params["record-link-group-type"] = params["record_link_group_type"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRecordLinkResults", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_histories_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_histories_api.py index 0561c7ae1..5b6e332dc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_histories_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_histories_api.py @@ -62,7 +62,6 @@ def copy_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str body: GsaCopyRecordHistory @@ -174,9 +173,7 @@ def copy_record_history_in_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str body: GsaCopyRecordHistory @@ -296,9 +293,7 @@ def create_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateRecordHistory Returns @@ -409,7 +404,6 @@ def get_latest_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -522,9 +516,7 @@ def get_latest_record_version_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -650,7 +642,6 @@ def get_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -763,9 +754,7 @@ def get_record_history_from_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -890,7 +879,6 @@ def move_record_history( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) record_history_guid: str body: GsaMoveRecordHistory @@ -1002,9 +990,7 @@ def move_record_history_in_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str body: GsaMoveRecordHistory diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_versions_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_versions_api.py index 6656db333..f85b399da 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_versions_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/records___record_versions_api.py @@ -63,9 +63,7 @@ def delete_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -187,9 +185,7 @@ def get_modifiable_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -316,9 +312,7 @@ def get_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str mode: str @@ -440,133 +434,6 @@ def _get_record_version_with_http_info( response_type_map=response_type_map, ) - def get_record_version_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given record version. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_record_version_permission_category_access_controls_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_record_version_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_record_version_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'get_record_version_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def release_record_version( self, *, @@ -582,9 +449,7 @@ def release_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str @@ -694,146 +559,6 @@ def _release_record_version_with_http_info( response_type_map=response_type_map, ) - def update_record_version_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given record version. Sets the access control for the given permissions. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - record_history_guid: str - record_version_guid: str - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_record_version_permission_category_access_controls_with_http_info( - database_key, - table_guid, - record_history_guid, - record_version_guid, - body, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _update_record_version_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - record_history_guid: "str", - record_version_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "record_history_guid", - "record_version_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_record_version_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_history_guid" is set - if "record_history_guid" not in params or params["record_history_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_history_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - # verify the required parameter "record_version_guid" is set - if "record_version_guid" not in params or params["record_version_guid"] is None: - raise ValueError( - "Missing the required parameter 'record_version_guid' when calling 'update_record_version_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "record_history_guid" in params and record_history_guid is not None: - path_params["record-history-guid"] = params["record_history_guid"] - if "record_version_guid" in params and record_version_guid is not None: - path_params["record-version-guid"] = params["record_version_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def withdraw_record_version( self, *, @@ -849,9 +574,7 @@ def withdraw_record_version( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_history_guid: str record_version_guid: str diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___attributes_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___attributes_api.py index c1a7488b2..db53c6231 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___attributes_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___attributes_api.py @@ -58,9 +58,7 @@ def create_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateAttribute Returns @@ -171,11 +169,8 @@ def create_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaCreateAttribute Returns @@ -290,11 +285,8 @@ def delete_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) Returns ------- @@ -395,9 +387,7 @@ def delete_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str Returns @@ -505,11 +495,8 @@ def get_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -619,111 +606,6 @@ def _get_attribute_with_http_info( response_type_map=response_type_map, ) - def get_attribute_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str", attribute_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given attribute. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, attribute_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_attribute_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", attribute_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "attribute_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_attribute_permission_category_access_controls'" - ) - # verify the required parameter "attribute_guid" is set - if "attribute_guid" not in params or params["attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'attribute_guid' when calling 'get_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "attribute_guid" in params and attribute_guid is not None: - path_params["attribute-guid"] = params["attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_attributes( self, *, @@ -739,9 +621,7 @@ def get_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -853,11 +733,8 @@ def get_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -982,9 +859,7 @@ def get_meta_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1096,11 +971,8 @@ def get_meta_attributes_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -1226,9 +1098,7 @@ def query_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaQueryAttributesRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -1336,120 +1206,6 @@ def _query_attributes_with_http_info( response_type_map=response_type_map, ) - def query_attributes_in_database( - self, - *, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaQueryAttributesInfo | None": - """Get attributes in database, populate the requested properties. Optionally filter the returned attributes. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaQueryAttributesRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaQueryAttributesInfo | None - """ - data = self._query_attributes_in_database_with_http_info( - database_key, body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _query_attributes_in_database_with_http_info( - self, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_attributes_in_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_attributes_in_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryAttributesInfo", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/attributes:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def query_meta_attributes( self, *, @@ -1466,9 +1222,7 @@ def query_meta_attributes( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaQueryAttributesRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -1593,11 +1347,8 @@ def query_meta_attributes_for_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaQueryAttributesRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -1720,120 +1471,6 @@ def _query_meta_attributes_for_attribute_with_http_info( response_type_map=response_type_map, ) - def query_meta_attributes_in_database( - self, - *, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaQueryAttributesInfo | None": - """Get meta-attributes in database, populate the requested properties. Optionally filter the returned meta-attributes. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaQueryAttributesRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - - Returns - ------- - GsaQueryAttributesInfo | None - """ - data = self._query_meta_attributes_in_database_with_http_info( - database_key, body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _query_meta_attributes_in_database_with_http_info( - self, - database_key: "str", - body: "Optional[GsaQueryAttributesRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_meta_attributes_in_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_meta_attributes_in_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryAttributesInfo", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/meta-attributes:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_attribute( self, *, @@ -1849,11 +1486,8 @@ def update_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaUpdateAttribute Returns @@ -1958,131 +1592,6 @@ def _update_attribute_with_http_info( response_type_map=response_type_map, ) - def update_attribute_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given attribute. Sets the access control for the given permissions. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_attribute_permission_category_access_controls_with_http_info( - database_key, table_guid, attribute_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_attribute_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - attribute_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "attribute_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_attribute_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_attribute_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_attribute_permission_category_access_controls'" - ) - # verify the required parameter "attribute_guid" is set - if "attribute_guid" not in params or params["attribute_guid"] is None: - raise ValueError( - "Missing the required parameter 'attribute_guid' when calling 'update_attribute_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "attribute_guid" in params and attribute_guid is not None: - path_params["attribute-guid"] = params["attribute_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_meta_attribute( self, *, @@ -2098,9 +1607,7 @@ def update_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str body: GsaUpdateAttribute @@ -2221,11 +1728,8 @@ def validate_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaValidateAttributeRequest Returns @@ -2345,11 +1849,8 @@ def validate_meta_attribute( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) meta_attribute_guid: str - See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes) body: GsaValidateAttributeRequest Returns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___configurations_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___configurations_api.py index 68f2a09a5..539efa15d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___configurations_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___configurations_api.py @@ -54,7 +54,7 @@ def create_configuration( database_key: "str", configuration_type: "str", body: "Optional[GsaCreateConfiguration]" = None, - ) -> "GsaConfiguration | GsaFileCreationException | None": + ) -> "GsaConfiguration | None": """Create a new configuration. This method makes a synchronous HTTP request. @@ -62,14 +62,13 @@ def create_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. body: GsaCreateConfiguration Returns ------- - GsaConfiguration | GsaFileCreationException | None + GsaConfiguration | None """ data = self._create_configuration_with_http_info( database_key, configuration_type, body, _return_http_data_only=True @@ -139,7 +138,7 @@ def _create_configuration_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaConfiguration", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -170,9 +169,8 @@ def delete_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns @@ -267,7 +265,7 @@ def _delete_configuration_with_http_info( def export_configuration( self, *, database_key: "str", configuration_type: "str", configuration_guid: "str" - ) -> "None | str": + ) -> "None": """Get individual configuration as a file This method makes a synchronous HTTP request. @@ -275,14 +273,13 @@ def export_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns ------- - None | str + None """ data = self._export_configuration_with_http_info( database_key, configuration_type, configuration_guid, _return_http_data_only=True @@ -347,11 +344,9 @@ def _export_configuration_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -371,101 +366,6 @@ def _export_configuration_with_http_info( response_type_map=response_type_map, ) - def export_configurations( - self, *, database_key: "str", configuration_type: "str" - ) -> "None | str": - """Get configurations as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - configuration_type: str - The configuration type as entered. - - Returns - ------- - None | str - """ - data = self._export_configurations_with_http_info( - database_key, configuration_type, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_configurations_with_http_info( - self, database_key: "str", configuration_type: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "configuration_type", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_configurations" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_configurations'" - ) - # verify the required parameter "configuration_type" is set - if "configuration_type" not in params or params["configuration_type"] is None: - raise ValueError( - "Missing the required parameter 'configuration_type' when calling 'export_configurations'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "configuration_type" in params and configuration_type is not None: - path_params["configuration-type"] = params["configuration_type"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["application/zip", "application/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_configuration( self, *, database_key: "str", configuration_type: "str", configuration_guid: "str" ) -> "GsaConfiguration | None": @@ -476,9 +376,8 @@ def get_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str Returns @@ -582,9 +481,8 @@ def get_configurations( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. Returns ------- @@ -665,99 +563,6 @@ def _get_configurations_with_http_info( response_type_map=response_type_map, ) - def get_descendants( - self, *, database_key: "str", configuration_type: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all configurations for the specified type. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - configuration_type: str - The configuration type as entered. - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_descendants_with_http_info( - database_key, configuration_type, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_descendants_with_http_info( - self, database_key: "str", configuration_type: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "configuration_type", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_descendants'" - ) - # verify the required parameter "configuration_type" is set - if "configuration_type" not in params or params["configuration_type"] is None: - raise ValueError( - "Missing the required parameter 'configuration_type' when calling 'get_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "configuration_type" in params and configuration_type is not None: - path_params["configuration-type"] = params["configuration_type"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_configuration( self, *, @@ -765,7 +570,7 @@ def update_configuration( configuration_type: "str", configuration_guid: "str", body: "Optional[GsaUpdateConfiguration]" = None, - ) -> "GsaConfiguration | GsaFileUpdateException | None": + ) -> "GsaConfiguration | None": """Update a configuration. This method makes a synchronous HTTP request. @@ -773,15 +578,14 @@ def update_configuration( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) configuration_type: str - The configuration type as entered. + The configuration type. configuration_guid: str body: GsaUpdateConfiguration Returns ------- - GsaConfiguration | GsaFileUpdateException | None + GsaConfiguration | None """ data = self._update_configuration_with_http_info( database_key, configuration_type, configuration_guid, body, _return_http_data_only=True @@ -860,7 +664,7 @@ def _update_configuration_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaConfiguration", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___constants_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___constants_api.py index a176ff7a3..1764f8a04 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___constants_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___constants_api.py @@ -50,7 +50,7 @@ class SchemaConstantsApi(ApiBase): def create_constant( self, *, database_key: "str", body: "Optional[GsaCreateConstant]" = None - ) -> "GsaConstant | GsaConstantCreationException | None": + ) -> "GsaConstant | None": """Create a new constant. This method makes a synchronous HTTP request. @@ -64,7 +64,7 @@ def create_constant( Returns ------- - GsaConstant | GsaConstantCreationException | None + GsaConstant | None """ data = self._create_constant_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -120,7 +120,7 @@ def _create_constant_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaConstant", - 400: "GsaConstantCreationException", + 400: None, 403: None, 404: None, } @@ -335,7 +335,6 @@ def get_constants(self, *, database_key: "str") -> "GsaConstantsInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -410,7 +409,7 @@ def update_constant( database_key: "str", constant_guid: "str", body: "Optional[GsaUpdateConstant]" = None, - ) -> "GsaConstant | GsaConstantUpdateException | None": + ) -> "GsaConstant | None": """Update constant. This method makes a synchronous HTTP request. @@ -426,7 +425,7 @@ def update_constant( Returns ------- - GsaConstant | GsaConstantUpdateException | None + GsaConstant | None """ data = self._update_constant_with_http_info( database_key, constant_guid, body, _return_http_data_only=True @@ -496,7 +495,7 @@ def _update_constant_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaConstant", - 400: "GsaConstantUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___data_rules_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___data_rules_api.py index b9a36d379..92f7cf2ee 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___data_rules_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___data_rules_api.py @@ -58,7 +58,6 @@ def create_data_rule( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateDataRule Returns @@ -150,7 +149,6 @@ def delete_data_rule(self, *, database_key: "str", data_rule_guid: "str") -> "No Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str Returns @@ -240,7 +238,6 @@ def get_data_rule(self, *, database_key: "str", data_rule_guid: "str") -> "GsaDa Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str Returns @@ -330,7 +327,6 @@ def get_data_rules(self, *, database_key: "str") -> "GsaDataRulesInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -413,7 +409,6 @@ def update_data_rule( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) data_rule_guid: str body: GsaUpdateDataRule diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___databases_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___databases_api.py index 7db142099..cd1a12fc2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___databases_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___databases_api.py @@ -122,528 +122,30 @@ def _add_database_with_http_info( response_type_map=response_type_map, ) - def check_databases_for_retarget_potential( - self, *, body: "Optional[GsaRetargetPotentialRequest]" = None - ) -> "GsaDatabasesInfo | None": - """Check databases for retarget potential - whether there are any cross-database tabular attributes targeting them. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaRetargetPotentialRequest - - Returns - ------- - GsaDatabasesInfo | None - """ - data = self._check_databases_for_retarget_potential_with_http_info( - body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _check_databases_for_retarget_potential_with_http_info( - self, body: "Optional[GsaRetargetPotentialRequest]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method check_databases_for_retarget_potential" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabasesInfo", - 400: None, - } - - return self.api_client.call_api( - "/v1alpha/databases:check-retarget-potential", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_all_databases(self, *, role: "Optional[str]" = None) -> "GsaDatabasesInfo": """Lists all databases that the user can see. This method makes a synchronous HTTP request. Parameters - ---------- - role: str - - Returns - ------- - GsaDatabasesInfo - """ - data = self._get_all_databases_with_http_info(role, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_databases_with_http_info(self, role: "Optional[str]" = None, **kwargs: Any) -> Any: - all_params = ["role", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_databases" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - if "role" in params and role is not None: - query_params.append(("role", params["role"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabasesInfo", - } - - return self.api_client.call_api( - "/v1alpha/databases", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_all_table_types(self, *, database_key: "str") -> "GsaTableTypesInfo | None": - """Get Protection Status for a given database. The user must be an Admin user for the database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - - Returns - ------- - GsaTableTypesInfo | None - """ - data = self._get_all_table_types_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_all_table_types_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_table_types" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_all_table_types'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaTableTypesInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/all-table-types", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_database(self, *, database_key: "str") -> "GsaDatabase | None": - """Returns details for a given database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaDatabase | None - """ - data = self._get_database_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_database'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_database_permission_category_access_controls( - self, *, database_key: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for the database. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_database_permission_category_access_controls_with_http_info( - database_key, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_database_permission_category_access_controls_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_database_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_additional_sql_parameters(self) -> "GsaAdditionalSqlParameters | None": - """Returns additional SQL parameters used by the configuration database. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaAdditionalSqlParameters | None - """ - data = self._get_default_additional_sql_parameters_with_http_info( - _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_default_additional_sql_parameters_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_additional_sql_parameters" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaAdditionalSqlParameters", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/defaultAdditionalSqlParameters", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_data_source(self) -> "GsaDataSource | None": - """Returns data source used by the configuration database. - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaDataSource | None - """ - data = self._get_default_data_source_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_default_data_source_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_data_source" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDataSource", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/defaultDataSource", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_default_database(self) -> "GsaDatabase | None": - """Returns details for a default database or null if the default database is not set or user cannot see it. - - This method makes a synchronous HTTP request. + ---------- + role: str Returns ------- - GsaDatabase | None + GsaDatabasesInfo """ - data = self._get_default_database_with_http_info(_return_http_data_only=True) + data = self._get_all_databases_with_http_info(role, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_default_database_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] + def _get_all_databases_with_http_info(self, role: "Optional[str]" = None, **kwargs: Any) -> Any: + all_params = ["role", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_database" + f"Got an unexpected keyword argument '{key}' to method get_all_databases" ) params[key] = val del params["kwargs"] @@ -653,6 +155,8 @@ def _get_default_database_with_http_info(self, **kwargs: Any) -> Any: path_params: dict[str, Any] = {} query_params: list[Any] = [] + if "role" in params and role is not None: + query_params.append(("role", params["role"])) header_params: dict[str, Any] = {} @@ -664,12 +168,11 @@ def _get_default_database_with_http_info(self, **kwargs: Any) -> Any: header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 204: None, + 200: "GsaDatabasesInfo", } return self.api_client.call_api( - "/v1alpha/databases/default", + "/v1alpha/databases", "GET", path_params, query_params, @@ -684,51 +187,25 @@ def _get_default_database_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_outbound_links( - self, - *, - database_key: "str", - type: "Optional[list[GsaLinkAttributeType]]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaLinksInfo | None": - """Get all link groups and tabular attributes pointing from the database, i.e. the source of the link is in the given database. May include links where the target is in the same database, or where the target cannot be resolved (e.g. the target database is not loaded). + def get_database(self, *, database_key: "str") -> "GsaDatabase | None": + """Returns details for a given database. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - type: list[GsaLinkAttributeType] - The link types to include in the response. If not provided, all link types are included. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. Returns ------- - GsaLinksInfo | None + GsaDatabase | None """ - data = self._get_outbound_links_with_http_info( - database_key, type, mode, x_ansys_vc_mode, _return_http_data_only=True - ) + data = self._get_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_outbound_links_with_http_info( - self, - database_key: "str", - type: "Optional[list[GsaLinkAttributeType]]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: + def _get_database_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: all_params = [ "database_key", - "type", - "mode", - "x_ansys_vc_mode", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -738,14 +215,14 @@ def _get_outbound_links_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_outbound_links" + f"Got an unexpected keyword argument '{key}' to method get_database" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_outbound_links'" + "Missing the required parameter 'database_key' when calling 'get_database'" ) collection_formats: dict[str, Any] = {} @@ -755,15 +232,8 @@ def _get_outbound_links_with_http_info( path_params["database-key"] = params["database_key"] query_params: list[Any] = [] - if "type" in params and type is not None: - query_params.append(("type", params["type"])) - collection_formats["type"] = "multi" - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] form_params: list[Any] = [] local_var_files: dict[str, Any] = {} @@ -773,14 +243,13 @@ def _get_outbound_links_with_http_info( header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaLinksInfo", - 403: None, + 200: "GsaDatabase", 404: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}:outbound-links", - "POST", + "/v1alpha/databases/{database-key}", + "GET", path_params, query_params, header_params, @@ -881,7 +350,6 @@ def reload_database(self, *, database_key: "str") -> "GsaSlimDatabase | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -960,7 +428,6 @@ def remove_database(self, *, database_key: "str") -> "None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1029,82 +496,6 @@ def _remove_database_with_http_info(self, database_key: "str", **kwargs: Any) -> response_type_map=response_type_map, ) - def retarget_tabulars( - self, *, body: "Optional[GsaRetargetRequest]" = None - ) -> "GsaRetargetResultsInfo | None": - """Retargets tabulars from the current database to a new one. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaRetargetRequest - - Returns - ------- - GsaRetargetResultsInfo | None - """ - data = self._retarget_tabulars_with_http_info(body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _retarget_tabulars_with_http_info( - self, body: "Optional[GsaRetargetRequest]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method retarget_tabulars" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaRetargetResultsInfo", - 400: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases:retarget", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def unlock_database(self, *, database_key: "str") -> "GsaDatabase | None": """Unlock database @@ -1198,7 +589,6 @@ def update_database( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaUpdateDatabase allow_reload: bool This must be set to true if any of the following properties are patched: DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid. The database will reload after the changes have been applied. @@ -1291,187 +681,7 @@ def _update_database_with_http_info( response_type_map=response_type_map, ) - def update_database_permission_category_access_controls( - self, - *, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for the database. Sets the access control for the given permissions. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_database_permission_category_access_controls_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_database_permission_category_access_controls_with_http_info( - self, - database_key: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_database_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_database_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_default_database( - self, *, body: "Optional[GsaUpdateDefaultDatabase]" = None - ) -> "GsaDatabase | None": - """Sets the default database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - body: GsaUpdateDefaultDatabase - - Returns - ------- - GsaDatabase | None - """ - data = self._update_default_database_with_http_info(body, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _update_default_database_with_http_info( - self, body: "Optional[GsaUpdateDefaultDatabase]" = None, **kwargs: Any - ) -> Any: - all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_default_database" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabase", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/default", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def upgrade_database( - self, *, database_key: "str" - ) -> "GsaSlimDatabase | GsaUpgradeDatabaseException | None": + def upgrade_database(self, *, database_key: "str") -> "GsaSlimDatabase | None": """Upgrade a database to the latest schema version. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. @@ -1479,11 +689,10 @@ def upgrade_database( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- - GsaSlimDatabase | GsaUpgradeDatabaseException | None + GsaSlimDatabase | None """ data = self._upgrade_database_with_http_info(database_key, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -1528,8 +737,8 @@ def _upgrade_database_with_http_info(self, database_key: "str", **kwargs: Any) - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUpgradeDatabaseException", 200: "GsaSlimDatabase", + 400: None, 403: None, 404: None, } @@ -1551,19 +760,19 @@ def _upgrade_database_with_http_info(self, database_key: "str", **kwargs: Any) - ) def upgrade_database_not_added_to_mi( - self, *, body: "Optional[GsaInputConnectionDetails]" = None - ) -> "GsaUpgradeDatabaseException | None": + self, *, body: "Optional[GsaConnectionDetails]" = None + ) -> "None": """Upgrades an external database to the latest schema version. Only available to users in the System Administrator role. This method makes a synchronous HTTP request. Parameters ---------- - body: GsaInputConnectionDetails + body: GsaConnectionDetails Returns ------- - GsaUpgradeDatabaseException | None + None """ data = self._upgrade_database_not_added_to_mi_with_http_info( body, _return_http_data_only=True @@ -1571,7 +780,7 @@ def upgrade_database_not_added_to_mi( return data # type: ignore[no-any-return] def _upgrade_database_not_added_to_mi_with_http_info( - self, body: "Optional[GsaInputConnectionDetails]" = None, **kwargs: Any + self, body: "Optional[GsaConnectionDetails]" = None, **kwargs: Any ) -> Any: all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] @@ -1598,17 +807,14 @@ def _upgrade_database_not_added_to_mi_with_http_info( body_params = None if "body" in params and body is not None: body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( ["application/json-patch+json", "application/json", "text/json", "application/*+json"] ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUpgradeDatabaseException", 200: None, + 400: None, 403: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types___discrete_values_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types___discrete_values_api.py index e9176857d..d32c86351 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types___discrete_values_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types___discrete_values_api.py @@ -62,7 +62,6 @@ def create_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaDiscreteValuesCreateDiscreteValue @@ -169,7 +168,6 @@ def delete_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str @@ -276,7 +274,6 @@ def find_unused_discrete_values( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -369,7 +366,6 @@ def get_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str @@ -474,7 +470,6 @@ def get_discrete_values( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -563,14 +558,13 @@ def replace_discrete_values( discrete_type_guid: "str", body: "Optional[GsaDiscreteValuesReplaceDiscreteValuesInfo]" = None, ) -> "GsaDiscreteValuesDiscreteValuesInfo | None": - """Replace the whole discrete value collection for a given discrete type. This will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails. If any discrete values are included in the request that have a guid that matches an existing discrete value then the existing discrete value will be modified. If any discrete values are included in the request body where the name matches an existing discrete value but no guid is provided, or the guid does not match, the operation will fail. + """Replace the whole discrete value collection for a given discrete type. This will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails. This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaDiscreteValuesReplaceDiscreteValuesInfo @@ -682,7 +676,6 @@ def update_discrete_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str discrete_value_guid: str body: GsaDiscreteValuesUpdateDiscreteValue diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types_api.py index c1a12f0c4..c377a9290 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___discrete_types_api.py @@ -50,7 +50,7 @@ class SchemaDiscreteTypesApi(ApiBase): def create_discrete_type( self, *, database_key: "str", body: "Optional[GsaCreateDiscreteType]" = None - ) -> "GsaDiscreteType | None": + ) -> "GsaSlimDiscreteType | None": """Create a new discrete type. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateDiscreteType Returns ------- - GsaDiscreteType | None + GsaSlimDiscreteType | None """ data = self._create_discrete_type_with_http_info( database_key, body, _return_http_data_only=True @@ -120,7 +119,7 @@ def _create_discrete_type_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 201: "GsaDiscreteType", + 201: "GsaSlimDiscreteType", 400: None, 403: None, 404: None, @@ -152,7 +151,6 @@ def delete_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -237,11 +235,7 @@ def _delete_discrete_type_with_http_info( ) def get_attributes_for_type( - self, - *, - database_key: "str", - discrete_type_guid: "str", - response_filters: "Optional[list[GsaDiscreteTypeUsageType]]" = None, + self, *, database_key: "str", discrete_type_guid: "str" ) -> "GsaDiscreteTypeUsage | None": """Gets objects that are using this discrete type. @@ -250,31 +244,23 @@ def get_attributes_for_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str - response_filters: list[GsaDiscreteTypeUsageType] - The discrete type usage types to include in the response. If none are provided, all types are included. Returns ------- GsaDiscreteTypeUsage | None """ data = self._get_attributes_for_type_with_http_info( - database_key, discrete_type_guid, response_filters, _return_http_data_only=True + database_key, discrete_type_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _get_attributes_for_type_with_http_info( - self, - database_key: "str", - discrete_type_guid: "str", - response_filters: "Optional[list[GsaDiscreteTypeUsageType]]" = None, - **kwargs: Any, + self, database_key: "str", discrete_type_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "discrete_type_guid", - "response_filters", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -308,9 +294,6 @@ def _get_attributes_for_type_with_http_info( path_params["discrete-type-guid"] = params["discrete_type_guid"] query_params: list[Any] = [] - if "response_filters" in params and response_filters is not None: - query_params.append(("response-filters", params["response_filters"])) - collection_formats["response-filters"] = "multi" header_params: dict[str, Any] = {} @@ -353,7 +336,6 @@ def get_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str Returns @@ -443,7 +425,6 @@ def get_discrete_types(self, *, database_key: "str") -> "GsaDiscreteTypesInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -523,7 +504,6 @@ def query_discrete_types( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaQueryDiscreteTypesRequest Returns @@ -623,7 +603,6 @@ def update_discrete_type( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) discrete_type_guid: str body: GsaUpdateDiscreteType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___display_names_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___display_names_api.py deleted file mode 100644 index a104d0894..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___display_names_api.py +++ /dev/null @@ -1,236 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaDisplayNamesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_all_display_names( - self, *, database_key: "str", language: "str" - ) -> "GsaDisplayNamesInfo | None": - """Gets display names for all localized entities in the database, in the given language. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - language: str - - Returns - ------- - GsaDisplayNamesInfo | None - """ - data = self._get_all_display_names_with_http_info( - database_key, language, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_all_display_names_with_http_info( - self, database_key: "str", language: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "language", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_all_display_names" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_all_display_names'" - ) - # verify the required parameter "language" is set - if "language" not in params or params["language"] is None: - raise ValueError( - "Missing the required parameter 'language' when calling 'get_all_display_names'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "language" in params and language is not None: - path_params["language"] = params["language"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaDisplayNamesInfo", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/display-names/{language}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def import_display_names( - self, *, database_key: "str", body: "Optional[GsaUpdateDisplayNames]" = None - ) -> "GsaDisplayNamesImportException | GsaUpdateDisplayNamesResponse | None": - """Updates display names for localized entities in the database. Returns the number of entities updated. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdateDisplayNames - - Returns - ------- - GsaDisplayNamesImportException | GsaUpdateDisplayNamesResponse | None - """ - data = self._import_display_names_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _import_display_names_with_http_info( - self, database_key: "str", body: "Optional[GsaUpdateDisplayNames]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method import_display_names" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'import_display_names'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUpdateDisplayNamesResponse", - 400: "GsaDisplayNamesImportException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/display-names", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___exporters_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___exporters_api.py index 1ac16572c..abe38bed3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___exporters_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___exporters_api.py @@ -55,7 +55,7 @@ def create_exporters_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Exporter File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_exporters_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_exporters_file_with_http_info( def create_exporters_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Exporters Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_exporters_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_exporters_file_with_http_info( response_type_map=response_type_map, ) - def delete_exporters_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_exporters_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete an Exporter Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_exporters_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_exporters_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_exporters_folder_with_http_info( def export_exporters_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get Exporter File as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_exporters_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_exporters_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,190 +544,6 @@ def _export_exporters_file_with_http_info( response_type_map=response_type_map, ) - def export_exporters_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get Exporter folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_exporters_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_exporters_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_exporters_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_exporters_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_exporters_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_exporter_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of an Exporter folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_exporter_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_exporter_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_exporter_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_exporter_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_exporter_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_exporter_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" ) -> "GsaFileHeader | None": @@ -752,7 +554,6 @@ def get_exporter_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -855,7 +656,6 @@ def get_exporters_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -949,7 +749,6 @@ def get_exporters_files( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1043,7 +842,6 @@ def get_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1135,7 +933,6 @@ def get_exporters_folders(self, *, database_key: "str") -> "GsaFoldersInfo | Non Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1214,7 +1011,6 @@ def get_exporters_root_folder(self, *, database_key: "str") -> "GsaFolder | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1294,7 +1090,7 @@ def move_exporters_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Exporter File. This method makes a synchronous HTTP request. @@ -1302,14 +1098,13 @@ def move_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_exporters_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1390,7 +1185,7 @@ def _move_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1413,7 +1208,7 @@ def _move_exporters_file_with_http_info( def move_exporters_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Exporter Folder. This method makes a synchronous HTTP request. @@ -1421,13 +1216,12 @@ def move_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_exporters_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1499,7 +1293,7 @@ def _move_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1528,7 +1322,6 @@ def refetch_exporters(self, *, database_key: "str") -> "GsaExporterRefetchInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1608,7 +1401,7 @@ def update_exporters_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Exporter File. This method makes a synchronous HTTP request. @@ -1616,14 +1409,13 @@ def update_exporters_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_exporters_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1704,7 +1496,7 @@ def _update_exporters_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1727,7 +1519,7 @@ def _update_exporters_file_with_http_info( def update_exporters_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Exporters Folder. This method makes a synchronous HTTP request. @@ -1735,13 +1527,12 @@ def update_exporters_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_exporters_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1813,7 +1604,7 @@ def _update_exporters_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___expressions_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___expressions_api.py index 56605cab7..3a6251e33 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___expressions_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___expressions_api.py @@ -62,9 +62,7 @@ def create_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateExpression Returns @@ -170,9 +168,7 @@ def delete_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str Returns @@ -278,9 +274,7 @@ def get_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -391,110 +385,6 @@ def _get_expression_with_http_info( response_type_map=response_type_map, ) - def get_expression_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str", expression_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given expression. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - expression_guid: str - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_expression_permission_category_access_controls_with_http_info( - database_key, table_guid, expression_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_expression_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", expression_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "expression_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_expression_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_expression_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_expression_permission_category_access_controls'" - ) - # verify the required parameter "expression_guid" is set - if "expression_guid" not in params or params["expression_guid"] is None: - raise ValueError( - "Missing the required parameter 'expression_guid' when calling 'get_expression_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "expression_guid" in params and expression_guid is not None: - path_params["expression-guid"] = params["expression_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_expressions( self, *, @@ -510,9 +400,7 @@ def get_expressions( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -623,9 +511,7 @@ def update_expression( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) expression_guid: str body: GsaUpdateExpression @@ -730,127 +616,3 @@ def _update_expression_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_expression_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - expression_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given expression. Sets the access control for the given permissions. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - expression_guid: str - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_expression_permission_category_access_controls_with_http_info( - database_key, table_guid, expression_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_expression_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - expression_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "expression_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_expression_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_expression_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_expression_permission_category_access_controls'" - ) - # verify the required parameter "expression_guid" is set - if "expression_guid" not in params or params["expression_guid"] is None: - raise ValueError( - "Missing the required parameter 'expression_guid' when calling 'update_expression_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "expression_guid" in params and expression_guid is not None: - path_params["expression-guid"] = params["expression_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___help_files_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___help_files_api.py index 70f2901f5..c083196ce 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___help_files_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___help_files_api.py @@ -55,7 +55,7 @@ def create_help_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Help File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_help_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_help_file_with_http_info( def create_help_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Help File Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_help_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_help_file_with_http_info( response_type_map=response_type_map, ) - def delete_help_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_help_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete a Help File Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_help_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_help_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_help_folder_with_http_info( def export_help_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get help file as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_help_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_help_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,96 +544,6 @@ def _export_help_file_with_http_info( response_type_map=response_type_map, ) - def export_help_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get help folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_help_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_help_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_help_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_help_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_help_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_help_child_folders( self, *, database_key: "str", folder_guid: "str" ) -> "GsaFoldersInfo | None": @@ -658,7 +554,6 @@ def get_help_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -752,7 +647,6 @@ def get_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -845,100 +739,6 @@ def _get_help_file_with_http_info( response_type_map=response_type_map, ) - def get_help_file_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of a Help File folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_help_file_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_help_file_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_help_file_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_help_file_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_help_file_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_help_files(self, *, database_key: "str", folder_guid: "str") -> "GsaFilesInfo | None": """Get Files in a Folder @@ -947,7 +747,6 @@ def get_help_files(self, *, database_key: "str", folder_guid: "str") -> "GsaFile Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1039,7 +838,6 @@ def get_help_folder(self, *, database_key: "str", folder_guid: "str") -> "GsaFol Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1131,7 +929,6 @@ def get_help_folders(self, *, database_key: "str") -> "GsaFoldersInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1210,7 +1007,6 @@ def get_help_root_folder(self, *, database_key: "str") -> "GsaFolder | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1266,7 +1062,7 @@ def _get_help_root_folder_with_http_info(self, database_key: "str", **kwargs: An } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders:root-folder", + "/v1alpha/databases/{database-key}/help-folders/:root-folder", "GET", path_params, query_params, @@ -1288,7 +1084,7 @@ def move_help_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Help File. This method makes a synchronous HTTP request. @@ -1296,14 +1092,13 @@ def move_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_help_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1384,7 +1179,7 @@ def _move_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1407,7 +1202,7 @@ def _move_help_file_with_http_info( def move_help_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Help File Folder. This method makes a synchronous HTTP request. @@ -1415,13 +1210,12 @@ def move_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_help_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1493,7 +1287,7 @@ def _move_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1521,7 +1315,7 @@ def update_help_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Help File. This method makes a synchronous HTTP request. @@ -1529,14 +1323,13 @@ def update_help_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_help_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1617,7 +1410,7 @@ def _update_help_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1640,7 +1433,7 @@ def _update_help_file_with_http_info( def update_help_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Help File Folder. This method makes a synchronous HTTP request. @@ -1648,13 +1441,12 @@ def update_help_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_help_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1726,7 +1518,7 @@ def _update_help_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } @@ -1746,85 +1538,3 @@ def _update_help_folder_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def validate_help_paths( - self, *, database_key: "str" - ) -> "GsaHelpPathsValidationResponse | None": - """Verify that help pages exist for all attributes and parameters that have help paths defined. Returns schema entity and help path if the help path does not match an existing help page. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaHelpPathsValidationResponse | None - """ - data = self._validate_help_paths_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _validate_help_paths_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method validate_help_paths" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'validate_help_paths'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaHelpPathsValidationResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/help-folders:validate", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___home_pages_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___home_pages_api.py index f6bc7931c..1edded7ba 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___home_pages_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___home_pages_api.py @@ -55,7 +55,7 @@ def create_home_page_file( folder_guid: "str", file: "Optional[BinaryIO | pathlib.Path]" = None, description: "Optional[str]" = None, - ) -> "GsaFileCreationException | GsaFileHeader | None": + ) -> "GsaFileHeader | None": """Create a new Home Page File. This method makes a synchronous HTTP request. @@ -63,14 +63,13 @@ def create_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file: BinaryIO | pathlib.Path description: str Returns ------- - GsaFileCreationException | GsaFileHeader | None + GsaFileHeader | None """ data = self._create_home_page_file_with_http_info( database_key, folder_guid, file, description, _return_http_data_only=True @@ -144,7 +143,7 @@ def _create_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFileHeader", - 400: "GsaFileCreationException", + 400: None, 403: None, 404: None, } @@ -167,7 +166,7 @@ def _create_home_page_file_with_http_info( def create_home_page_folder( self, *, database_key: "str", body: "Optional[GsaCreateFolder]" = None - ) -> "GsaFolder | GsaFolderCreationException | None": + ) -> "GsaFolder | None": """Create a new Home Page Folder. This method makes a synchronous HTTP request. @@ -175,12 +174,11 @@ def create_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateFolder Returns ------- - GsaFolder | GsaFolderCreationException | None + GsaFolder | None """ data = self._create_home_page_folder_with_http_info( database_key, body, _return_http_data_only=True @@ -240,7 +238,7 @@ def _create_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaFolder", - 400: "GsaFolderCreationException", + 400: None, 403: None, 404: None, } @@ -271,7 +269,6 @@ def delete_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -361,9 +358,7 @@ def _delete_home_page_file_with_http_info( response_type_map=response_type_map, ) - def delete_home_page_folder( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFolderDeletionException | None": + def delete_home_page_folder(self, *, database_key: "str", folder_guid: "str") -> "None": """Delete a Home Page Folder. This method makes a synchronous HTTP request. @@ -371,12 +366,11 @@ def delete_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns ------- - GsaFolderDeletionException | None + None """ data = self._delete_home_page_folder_with_http_info( database_key, folder_guid, _return_http_data_only=True @@ -429,13 +423,8 @@ def _delete_home_page_folder_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) response_type_map: dict[int, Optional[str]] = { - 400: "GsaFolderDeletionException", 200: None, 403: None, 404: None, @@ -459,7 +448,7 @@ def _delete_home_page_folder_with_http_info( def export_home_page_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" - ) -> "None | str": + ) -> "None": """Get Home Page File as a file This method makes a synchronous HTTP request. @@ -467,13 +456,12 @@ def export_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str Returns ------- - None | str + None """ data = self._export_home_page_file_with_http_info( database_key, folder_guid, file_guid, _return_http_data_only=True @@ -534,11 +522,9 @@ def _export_home_page_file_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/octet-stream"]) response_type_map: dict[int, Optional[str]] = { - 200: "file", + 200: None, 404: None, } @@ -558,96 +544,6 @@ def _export_home_page_file_with_http_info( response_type_map=response_type_map, ) - def export_home_page_folder(self, *, database_key: "str", folder_guid: "str") -> "None | str": - """Get Home Page folder and contents as a zip file - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - None | str - """ - data = self._export_home_page_folder_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _export_home_page_folder_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method export_home_page_folder" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'export_home_page_folder'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'export_home_page_folder'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/zip"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "file", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:export", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_home_page_child_folders( self, *, database_key: "str", folder_guid: "str" ) -> "GsaFoldersInfo | None": @@ -658,7 +554,6 @@ def get_home_page_child_folders( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -742,100 +637,6 @@ def _get_home_page_child_folders_with_http_info( response_type_map=response_type_map, ) - def get_home_page_descendants( - self, *, database_key: "str", folder_guid: "str" - ) -> "GsaFileHeaderInfo | None": - """Returns file information for all descendants of a Home Page folder. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - folder_guid: str - - Returns - ------- - GsaFileHeaderInfo | None - """ - data = self._get_home_page_descendants_with_http_info( - database_key, folder_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_home_page_descendants_with_http_info( - self, database_key: "str", folder_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "folder_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_home_page_descendants" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_home_page_descendants'" - ) - # verify the required parameter "folder_guid" is set - if "folder_guid" not in params or params["folder_guid"] is None: - raise ValueError( - "Missing the required parameter 'folder_guid' when calling 'get_home_page_descendants'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "folder_guid" in params and folder_guid is not None: - path_params["folder-guid"] = params["folder_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFileHeaderInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:descendants", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_home_page_file( self, *, database_key: "str", folder_guid: "str", file_guid: "str" ) -> "GsaFileHeader | None": @@ -846,7 +647,6 @@ def get_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str @@ -949,7 +749,6 @@ def get_home_page_files( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1043,7 +842,6 @@ def get_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str Returns @@ -1135,7 +933,6 @@ def get_home_page_folders(self, *, database_key: "str") -> "GsaFoldersInfo | Non Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1214,7 +1011,6 @@ def get_home_page_root_folder(self, *, database_key: "str") -> "GsaFolder | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1294,7 +1090,7 @@ def move_home_page_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaMoveFile]" = None, - ) -> "GsaFileHeader | GsaFileMoveException | None": + ) -> "GsaFileHeader | None": """Move an existing Home Page File. This method makes a synchronous HTTP request. @@ -1302,14 +1098,13 @@ def move_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaMoveFile Returns ------- - GsaFileHeader | GsaFileMoveException | None + GsaFileHeader | None """ data = self._move_home_page_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1390,7 +1185,7 @@ def _move_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileMoveException", + 400: None, 403: None, 404: None, } @@ -1413,7 +1208,7 @@ def _move_home_page_file_with_http_info( def move_home_page_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaMoveFolder]" = None - ) -> "GsaFolder | GsaFolderMoveException | None": + ) -> "GsaFolder | None": """Move an existing Home Page Folder. This method makes a synchronous HTTP request. @@ -1421,13 +1216,12 @@ def move_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaMoveFolder Returns ------- - GsaFolder | GsaFolderMoveException | None + GsaFolder | None """ data = self._move_home_page_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1499,7 +1293,7 @@ def _move_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderMoveException", + 400: None, 403: None, 404: None, } @@ -1527,7 +1321,7 @@ def update_home_page_file( folder_guid: "str", file_guid: "str", body: "Optional[GsaUpdateFile]" = None, - ) -> "GsaFileHeader | GsaFileUpdateException | None": + ) -> "GsaFileHeader | None": """Update an existing Home Page File. This method makes a synchronous HTTP request. @@ -1535,14 +1329,13 @@ def update_home_page_file( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str file_guid: str body: GsaUpdateFile Returns ------- - GsaFileHeader | GsaFileUpdateException | None + GsaFileHeader | None """ data = self._update_home_page_file_with_http_info( database_key, folder_guid, file_guid, body, _return_http_data_only=True @@ -1623,7 +1416,7 @@ def _update_home_page_file_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFileHeader", - 400: "GsaFileUpdateException", + 400: None, 403: None, 404: None, } @@ -1646,7 +1439,7 @@ def _update_home_page_file_with_http_info( def update_home_page_folder( self, *, database_key: "str", folder_guid: "str", body: "Optional[GsaUpdateFolder]" = None - ) -> "GsaFolder | GsaFolderUpdateException | None": + ) -> "GsaFolder | None": """Update an existing Home Page Folder. This method makes a synchronous HTTP request. @@ -1654,13 +1447,12 @@ def update_home_page_folder( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) folder_guid: str body: GsaUpdateFolder Returns ------- - GsaFolder | GsaFolderUpdateException | None + GsaFolder | None """ data = self._update_home_page_folder_with_http_info( database_key, folder_guid, body, _return_http_data_only=True @@ -1732,7 +1524,7 @@ def _update_home_page_folder_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaFolder", - 400: "GsaFolderUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layout_sections_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layout_sections_api.py index 742825fe0..5f050ffd1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layout_sections_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layout_sections_api.py @@ -64,9 +64,7 @@ def create_layout_item( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str body: GsaNewLayoutItem @@ -197,9 +195,7 @@ def create_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaCreateLayoutSection @@ -321,9 +317,7 @@ def delete_item( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str item_guid: str @@ -450,9 +444,7 @@ def delete_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str @@ -574,9 +566,7 @@ def get_layout_section( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str section_guid: str show_full_detail: bool @@ -704,142 +694,6 @@ def _get_layout_section_with_http_info( response_type_map=response_type_map, ) - def get_layout_section_without_layout( - self, - *, - database_key: "str", - table_guid: "str", - section_guid: "str", - show_full_detail: "Optional[bool]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaLayoutSection | None": - """Get a layout section with a specified guid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - section_guid: str - show_full_detail: bool - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaLayoutSection | None - """ - data = self._get_layout_section_without_layout_with_http_info( - database_key, - table_guid, - section_guid, - show_full_detail, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_layout_section_without_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - section_guid: "str", - show_full_detail: "Optional[bool]" = None, - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "section_guid", - "show_full_detail", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_layout_section_without_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_layout_section_without_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_layout_section_without_layout'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'get_layout_section_without_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - if "show_full_detail" in params and show_full_detail is not None: - query_params.append(("showFullDetail", params["show_full_detail"])) - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaLayoutSection", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_layout_sections( self, *, @@ -857,9 +711,7 @@ def get_layout_sections( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str show_full_detail: bool mode: str @@ -976,150 +828,6 @@ def _get_layout_sections_with_http_info( response_type_map=response_type_map, ) - def query_layout_sections( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutSectionsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - ) -> "GsaQueryLayoutSectionsInfo | None": - """Query all layout sections for table, optionally filter layout sections returned - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaQueryLayoutSectionsRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - application: str - cascade_filter: bool - If cascadeFilter is true, we apply the filter to the returned layout items, as well as filtering the layout sections themselves. - - Returns - ------- - GsaQueryLayoutSectionsInfo | None - """ - data = self._query_layout_sections_with_http_info( - database_key, - table_guid, - body, - x_ansys_vc_mode, - mode, - application, - cascade_filter, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _query_layout_sections_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutSectionsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "x_ansys_vc_mode", - "mode", - "application", - "cascade_filter", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_layout_sections" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_layout_sections'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_layout_sections'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "application" in params and application is not None: - query_params.append(("application", params["application"])) - if "cascade_filter" in params and cascade_filter is not None: - query_params.append(("cascadeFilter", params["cascade_filter"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryLayoutSectionsInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def reorder_sections( self, *, @@ -1135,9 +843,7 @@ def reorder_sections( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaReorderSectionsInfo @@ -1242,260 +948,3 @@ def _reorder_sections_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_section( - self, - *, - database_key: "str", - table_guid: "str", - layout_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - ) -> "GsaFullLayoutSection | None": - """Update a layout section. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - layout_guid: str - section_guid: str - body: GsaUpdateLayoutSection - - Returns - ------- - GsaFullLayoutSection | None - """ - data = self._update_section_with_http_info( - database_key, table_guid, layout_guid, section_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_section_with_http_info( - self, - database_key: "str", - table_guid: "str", - layout_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "layout_guid", - "section_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_section" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_section'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_section'" - ) - # verify the required parameter "layout_guid" is set - if "layout_guid" not in params or params["layout_guid"] is None: - raise ValueError( - "Missing the required parameter 'layout_guid' when calling 'update_section'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'update_section'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "layout_guid" in params and layout_guid is not None: - path_params["layout-guid"] = params["layout_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFullLayoutSection", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def update_section_without_layout( - self, - *, - database_key: "str", - table_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - ) -> "GsaFullLayoutSection | None": - """Update a layout section. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - section_guid: str - body: GsaUpdateLayoutSection - - Returns - ------- - GsaFullLayoutSection | None - """ - data = self._update_section_without_layout_with_http_info( - database_key, table_guid, section_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_section_without_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - section_guid: "str", - body: "Optional[GsaUpdateLayoutSection]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "section_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_section_without_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_section_without_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_section_without_layout'" - ) - # verify the required parameter "section_guid" is set - if "section_guid" not in params or params["section_guid"] is None: - raise ValueError( - "Missing the required parameter 'section_guid' when calling 'update_section_without_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "section_guid" in params and section_guid is not None: - path_params["section-guid"] = params["section_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaFullLayoutSection", - 400: None, - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layouts_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layouts_api.py index e553ed5cd..2c3f26104 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layouts_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___layouts_api.py @@ -58,9 +58,7 @@ def applications( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -152,9 +150,7 @@ def create_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateLayout Returns @@ -260,9 +256,7 @@ def delete_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str Returns @@ -369,9 +363,7 @@ def get_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str show_full_detail: bool mode: str @@ -607,279 +599,6 @@ def _get_layouts_with_http_info( response_type_map=response_type_map, ) - def get_searchable_items_in_layout( - self, - *, - database_key: "str", - table_guid: "str", - layout_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GrantaMISearchFreeTextIdentifiers | None": - """Return the identifiers of items that should be included in a free text search over a specific layout - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - layout_guid: str - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GrantaMISearchFreeTextIdentifiers | None - """ - data = self._get_searchable_items_in_layout_with_http_info( - database_key, - table_guid, - layout_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_searchable_items_in_layout_with_http_info( - self, - database_key: "str", - table_guid: "str", - layout_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "layout_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_searchable_items_in_layout" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_searchable_items_in_layout'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_searchable_items_in_layout'" - ) - # verify the required parameter "layout_guid" is set - if "layout_guid" not in params or params["layout_guid"] is None: - raise ValueError( - "Missing the required parameter 'layout_guid' when calling 'get_searchable_items_in_layout'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "layout_guid" in params and layout_guid is not None: - path_params["layout-guid"] = params["layout_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GrantaMISearchFreeTextIdentifiers", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/searchable-items", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def query_layouts( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - ) -> "GsaQueryLayoutsInfo | None": - """Query all layouts for table, optionally filter layouts returned - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaQueryLayoutsRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - application: str - cascade_filter: bool - If cascadeFilter is true, we apply the filter to the returned layout sections and items, as well as filtering the layouts themselves. - - Returns - ------- - GsaQueryLayoutsInfo | None - """ - data = self._query_layouts_with_http_info( - database_key, - table_guid, - body, - x_ansys_vc_mode, - mode, - application, - cascade_filter, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _query_layouts_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaQueryLayoutsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - application: "Optional[str]" = None, - cascade_filter: "Optional[bool]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "x_ansys_vc_mode", - "mode", - "application", - "cascade_filter", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method query_layouts" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'query_layouts'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'query_layouts'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "application" in params and application is not None: - query_params.append(("application", params["application"])) - if "cascade_filter" in params and cascade_filter is not None: - query_params.append(("cascadeFilter", params["cascade_filter"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQueryLayoutsInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:query", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def update_layout( self, *, @@ -895,9 +614,7 @@ def update_layout( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) layout_guid: str body: GsaUpdateLayout diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___parameters_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___parameters_api.py index 7d038d0ce..850735761 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___parameters_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___parameters_api.py @@ -50,7 +50,7 @@ class SchemaParametersApi(ApiBase): def create_parameter( self, *, database_key: "str", body: "Optional[GsaCreateParameter]" = None - ) -> "GsaParameter | GsaParameterCreationException | None": + ) -> "GsaParameter | None": """Create a new parameter. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateParameter Returns ------- - GsaParameter | GsaParameterCreationException | None + GsaParameter | None """ data = self._create_parameter_with_http_info( database_key, body, _return_http_data_only=True @@ -121,7 +120,7 @@ def _create_parameter_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaParameter", - 400: "GsaParameterCreationException", + 400: None, 403: None, 404: None, } @@ -148,7 +147,7 @@ def create_parameter_value( database_key: "str", parameter_guid: "str", body: "Optional[GsaCreateParameterValue]" = None, - ) -> "GsaParameterValue | GsaParameterValueCreationException | None": + ) -> "GsaParameterValue | None": """Create a new parameter value. This method makes a synchronous HTTP request. @@ -156,13 +155,12 @@ def create_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str body: GsaCreateParameterValue Returns ------- - GsaParameterValue | GsaParameterValueCreationException | None + GsaParameterValue | None """ data = self._create_parameter_value_with_http_info( database_key, parameter_guid, body, _return_http_data_only=True @@ -232,7 +230,7 @@ def _create_parameter_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaParameterValue", - 400: "GsaParameterValueCreationException", + 400: None, 403: None, 404: None, } @@ -263,7 +261,6 @@ def delete_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -357,7 +354,6 @@ def delete_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str @@ -460,7 +456,6 @@ def get_objects_using_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -550,7 +545,6 @@ def get_parameter(self, *, database_key: "str", parameter_guid: "str") -> "GsaPa Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str Returns @@ -642,7 +636,6 @@ def get_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str @@ -741,7 +734,6 @@ def get_parameters(self, *, database_key: "str") -> "GsaParametersInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -816,7 +808,7 @@ def update_parameter( database_key: "str", parameter_guid: "str", body: "Optional[GsaUpdateParameter]" = None, - ) -> "GsaParameter | GsaParameterUpdateException | None": + ) -> "GsaParameter | None": """Update a parameter. This method makes a synchronous HTTP request. @@ -824,13 +816,12 @@ def update_parameter( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str body: GsaUpdateParameter Returns ------- - GsaParameter | GsaParameterUpdateException | None + GsaParameter | None """ data = self._update_parameter_with_http_info( database_key, parameter_guid, body, _return_http_data_only=True @@ -900,7 +891,7 @@ def _update_parameter_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaParameter", - 400: "GsaParameterUpdateException", + 400: None, 403: None, 404: None, } @@ -928,7 +919,7 @@ def update_parameter_value( parameter_guid: "str", parameter_value_guid: "str", body: "Optional[GsaUpdateParameterValue]" = None, - ) -> "GsaParameterValue | GsaParameterValueUpdateException | None": + ) -> "GsaParameterValue | None": """Update a parameter value. This method makes a synchronous HTTP request. @@ -936,14 +927,13 @@ def update_parameter_value( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) parameter_guid: str parameter_value_guid: str body: GsaUpdateParameterValue Returns ------- - GsaParameterValue | GsaParameterValueUpdateException | None + GsaParameterValue | None """ data = self._update_parameter_value_with_http_info( database_key, parameter_guid, parameter_value_guid, body, _return_http_data_only=True @@ -1022,7 +1012,7 @@ def _update_parameter_value_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaParameterValue", - 400: "GsaParameterValueUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___quality_systems_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___quality_systems_api.py deleted file mode 100644 index e320e7169..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___quality_systems_api.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaQualitySystemsApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_quality_system( - self, *, database_key: "str", quality_system_guid: "str" - ) -> "GsaQualitySystem | None": - """Get individual quality system - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - quality_system_guid: str - - Returns - ------- - GsaQualitySystem | None - """ - data = self._get_quality_system_with_http_info( - database_key, quality_system_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_quality_system_with_http_info( - self, database_key: "str", quality_system_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "quality_system_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_quality_system" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_quality_system'" - ) - # verify the required parameter "quality_system_guid" is set - if "quality_system_guid" not in params or params["quality_system_guid"] is None: - raise ValueError( - "Missing the required parameter 'quality_system_guid' when calling 'get_quality_system'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "quality_system_guid" in params and quality_system_guid is not None: - path_params["quality-system-guid"] = params["quality_system_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQualitySystem", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems/{quality-system-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_quality_systems(self, *, database_key: "str") -> "GsaQualitySystemsInfo | None": - """Get all quality systems - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - - Returns - ------- - GsaQualitySystemsInfo | None - """ - data = self._get_quality_systems_with_http_info(database_key, _return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_quality_systems_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: - all_params = [ - "database_key", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_quality_systems" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_quality_systems'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaQualitySystemsInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/quality-systems", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___record_link_groups_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___record_link_groups_api.py index ba06c41d2..716b7901e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___record_link_groups_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___record_link_groups_api.py @@ -54,7 +54,7 @@ def create_record_link_group( database_key: "str", table_guid: "str", body: "Optional[GsaCreateRecordLinkGroup]" = None, - ) -> "GsaRecordLinkGroup | GsaRecordLinkGroupCreationException | None": + ) -> "GsaRecordLinkGroup | None": """Create a new record link group. This method makes a synchronous HTTP request. @@ -62,14 +62,12 @@ def create_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateRecordLinkGroup Returns ------- - GsaRecordLinkGroup | GsaRecordLinkGroupCreationException | None + GsaRecordLinkGroup | None """ data = self._create_record_link_group_with_http_info( database_key, table_guid, body, _return_http_data_only=True @@ -139,7 +137,7 @@ def _create_record_link_group_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaRecordLinkGroup", - 400: "GsaRecordLinkGroupCreationException", + 400: None, 403: None, 404: None, } @@ -175,12 +173,10 @@ def delete_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str record_link_group_type: str - The record link group type as entered. + The record link group type. Returns ------- @@ -302,12 +298,10 @@ def get_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str record_link_group_type: str - The record link group type as entered. + The record link group type. mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -442,9 +436,7 @@ def get_record_link_groups( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -547,7 +539,7 @@ def update_record_link_group( table_guid: "str", record_link_group_guid: "str", body: "Optional[GsaUpdateRecordLinkGroup]" = None, - ) -> "GsaRecordLinkGroup | GsaRecordLinkGroupUpdateException | None": + ) -> "GsaRecordLinkGroup | None": """Update record link group. This method makes a synchronous HTTP request. @@ -555,15 +547,13 @@ def update_record_link_group( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) record_link_group_guid: str body: GsaUpdateRecordLinkGroup Returns ------- - GsaRecordLinkGroup | GsaRecordLinkGroupUpdateException | None + GsaRecordLinkGroup | None """ data = self._update_record_link_group_with_http_info( database_key, table_guid, record_link_group_guid, body, _return_http_data_only=True @@ -642,7 +632,7 @@ def _update_record_link_group_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaRecordLinkGroup", - 400: "GsaRecordLinkGroupUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_masks_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_masks_api.py deleted file mode 100644 index b5e4a145b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_masks_api.py +++ /dev/null @@ -1,262 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaSearchMasksApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_search_mask( - self, - *, - database_key: "str", - search_mask_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchMask | None": - """Get a specific search mask by GUID. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - search_mask_guid: str - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchMask | None - """ - data = self._get_search_mask_with_http_info( - database_key, search_mask_guid, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_mask_with_http_info( - self, - database_key: "str", - search_mask_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "search_mask_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_mask" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_mask'" - ) - # verify the required parameter "search_mask_guid" is set - if "search_mask_guid" not in params or params["search_mask_guid"] is None: - raise ValueError( - "Missing the required parameter 'search_mask_guid' when calling 'get_search_mask'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "search_mask_guid" in params and search_mask_guid is not None: - path_params["search-mask-guid"] = params["search_mask_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchMask", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/search-masks/{search-mask-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_masks( - self, - *, - database_key: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchMaskInfo | None": - """Get all search masks. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchMaskInfo | None - """ - data = self._get_search_masks_with_http_info( - database_key, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_masks_with_http_info( - self, - database_key: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_masks" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_masks'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchMaskInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/search-masks", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_templates_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_templates_api.py deleted file mode 100644 index d77da7665..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___search_templates_api.py +++ /dev/null @@ -1,291 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaSearchTemplatesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_search_template( - self, - *, - database_key: "str", - table_guid: "str", - search_template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchTemplate | None": - """Get a specific search template by GUID. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - search_template_guid: str - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchTemplate | None - """ - data = self._get_search_template_with_http_info( - database_key, - table_guid, - search_template_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_search_template_with_http_info( - self, - database_key: "str", - table_guid: "str", - search_template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "search_template_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_template" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_template'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_search_template'" - ) - # verify the required parameter "search_template_guid" is set - if "search_template_guid" not in params or params["search_template_guid"] is None: - raise ValueError( - "Missing the required parameter 'search_template_guid' when calling 'get_search_template'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - if "search_template_guid" in params and search_template_guid is not None: - path_params["search-template-guid"] = params["search_template_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchTemplate", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates/{search-template-guid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_templates( - self, - *, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaSearchTemplateInfo | None": - """Get all search templates for a table. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaSearchTemplateInfo | None - """ - data = self._get_search_templates_with_http_info( - database_key, table_guid, mode, x_ansys_vc_mode, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_templates_with_http_info( - self, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_templates" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_templates'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_search_templates'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchTemplateInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___standard_names_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___standard_names_api.py index 8ac516298..0af244577 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___standard_names_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___standard_names_api.py @@ -50,7 +50,7 @@ class SchemaStandardNamesApi(ApiBase): def create_standard_name( self, *, database_key: "str", body: "Optional[GsaCreateStandardName]" = None - ) -> "GsaStandardName | GsaStandardNameCreationException | None": + ) -> "GsaStandardName | None": """Create a new standard name This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateStandardName Returns ------- - GsaStandardName | GsaStandardNameCreationException | None + GsaStandardName | None """ data = self._create_standard_name_with_http_info( database_key, body, _return_http_data_only=True @@ -121,7 +120,7 @@ def _create_standard_name_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaStandardName", - 400: "GsaStandardNameCreationException", + 400: None, 403: None, 404: None, } @@ -142,13 +141,7 @@ def _create_standard_name_with_http_info( response_type_map=response_type_map, ) - def delete_standard_name( - self, - *, - database_key: "str", - standard_name_guid: "str", - force_non_custom: "Optional[bool]" = False, - ) -> "GsaStandardNameDeletionException | None": + def delete_standard_name(self, *, database_key: "str", standard_name_guid: "str") -> "None": """Delete a standard name. This method makes a synchronous HTTP request. @@ -156,31 +149,23 @@ def delete_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str - force_non_custom: bool - Optionally force the deletion for non-custom standard names. Returns ------- - GsaStandardNameDeletionException | None + None """ data = self._delete_standard_name_with_http_info( - database_key, standard_name_guid, force_non_custom, _return_http_data_only=True + database_key, standard_name_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _delete_standard_name_with_http_info( - self, - database_key: "str", - standard_name_guid: "str", - force_non_custom: "Optional[bool]" = False, - **kwargs: Any, + self, database_key: "str", standard_name_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "standard_name_guid", - "force_non_custom", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -214,8 +199,6 @@ def _delete_standard_name_with_http_info( path_params["standard-name-guid"] = params["standard_name_guid"] query_params: list[Any] = [] - if "force_non_custom" in params and force_non_custom is not None: - query_params.append(("forceNonCustom", params["force_non_custom"])) header_params: dict[str, Any] = {} @@ -223,12 +206,10 @@ def _delete_standard_name_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaStandardNameDeletionException", 200: None, + 400: None, 403: None, 404: None, } @@ -259,7 +240,6 @@ def get_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str Returns @@ -349,7 +329,6 @@ def get_standard_names(self, *, database_key: "str") -> "GsaStandardNamesInfo | Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -424,8 +403,7 @@ def update_standard_name( database_key: "str", standard_name_guid: "str", body: "Optional[GsaUpdateStandardName]" = None, - force_non_custom: "Optional[bool]" = False, - ) -> "GsaStandardName | GsaStandardNameUpdateException | None": + ) -> "GsaStandardName | None": """Edit a standard name This method makes a synchronous HTTP request. @@ -433,18 +411,15 @@ def update_standard_name( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) standard_name_guid: str body: GsaUpdateStandardName - force_non_custom: bool - Optionally force the update for non-custom standard names. Returns ------- - GsaStandardName | GsaStandardNameUpdateException | None + GsaStandardName | None """ data = self._update_standard_name_with_http_info( - database_key, standard_name_guid, body, force_non_custom, _return_http_data_only=True + database_key, standard_name_guid, body, _return_http_data_only=True ) return data # type: ignore[no-any-return] @@ -453,14 +428,12 @@ def _update_standard_name_with_http_info( database_key: "str", standard_name_guid: "str", body: "Optional[GsaUpdateStandardName]" = None, - force_non_custom: "Optional[bool]" = False, **kwargs: Any, ) -> Any: all_params = [ "database_key", "standard_name_guid", "body", - "force_non_custom", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -494,8 +467,6 @@ def _update_standard_name_with_http_info( path_params["standard-name-guid"] = params["standard_name_guid"] query_params: list[Any] = [] - if "force_non_custom" in params and force_non_custom is not None: - query_params.append(("forceNonCustom", params["force_non_custom"])) header_params: dict[str, Any] = {} @@ -515,7 +486,7 @@ def _update_standard_name_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaStandardName", - 400: "GsaStandardNameUpdateException", + 400: None, 403: None, 404: None, } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___subsets_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___subsets_api.py index 3bb863f01..73549b550 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___subsets_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___subsets_api.py @@ -63,9 +63,7 @@ def add_to_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaAddRecordHistoryToSubset @@ -178,9 +176,7 @@ def create_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaCreateSubset Returns @@ -286,9 +282,7 @@ def delete_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str Returns @@ -394,9 +388,7 @@ def get_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. @@ -520,9 +512,7 @@ def get_subsets( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -631,9 +621,7 @@ def remove_from_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaRemoveRecordHistoryFromSubset @@ -751,9 +739,7 @@ def update_subset( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) subset_guid: str body: GsaUpdateSubset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___tables_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___tables_api.py index 8f0f35688..39b41e94b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___tables_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___tables_api.py @@ -50,7 +50,7 @@ class SchemaTablesApi(ApiBase): def create_table( self, *, database_key: "str", body: "Optional[GsaCreateTable]" = None - ) -> "GsaTable | GsaTableCreationException | None": + ) -> "GsaTable | None": """Create a new table. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateTable Returns ------- - GsaTable | GsaTableCreationException | None + GsaTable | None """ data = self._create_table_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -119,7 +118,7 @@ def _create_table_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaTable", - 400: "GsaTableCreationException", + 400: None, 403: None, 404: None, } @@ -150,9 +149,7 @@ def delete_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -245,9 +242,7 @@ def enable_version_control( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -346,9 +341,7 @@ def get_inbound_links( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) type: list[GsaLinkAttributeType] The link types to include in the response. If not provided, all link types are included. mode: str @@ -466,9 +459,7 @@ def get_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -560,101 +551,6 @@ def _get_table_with_http_info( response_type_map=response_type_map, ) - def get_table_permission_category_access_controls( - self, *, database_key: "str", table_guid: "str" - ) -> "GsaPermissionCategoryAccessControlInfo | None": - """Get permission-based access control settings for a given table. Returns the access control for each permission in each category. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - - Returns - ------- - GsaPermissionCategoryAccessControlInfo | None - """ - data = self._get_table_permission_category_access_controls_with_http_info( - database_key, table_guid, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_table_permission_category_access_controls_with_http_info( - self, database_key: "str", table_guid: "str", **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_table_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_table_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_table_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_tables( self, *, @@ -669,7 +565,6 @@ def get_tables( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. x_ansys_vc_mode: str @@ -769,7 +664,6 @@ def query_tables( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaQueryTablesRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -877,9 +771,7 @@ def release_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) Returns ------- @@ -964,7 +856,7 @@ def _release_table_with_http_info( def update_table( self, *, database_key: "str", table_guid: "str", body: "Optional[GsaUpdateTable]" = None - ) -> "GsaTable | GsaTableUpdateException | None": + ) -> "GsaTable | None": """Update a table. This method makes a synchronous HTTP request. @@ -972,14 +864,12 @@ def update_table( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaUpdateTable Returns ------- - GsaTable | GsaTableUpdateException | None + GsaTable | None """ data = self._update_table_with_http_info( database_key, table_guid, body, _return_http_data_only=True @@ -1049,7 +939,7 @@ def _update_table_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaTable", - 400: "GsaTableUpdateException", + 400: None, 403: None, 404: None, } @@ -1069,116 +959,3 @@ def _update_table_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def update_table_permission_category_access_controls( - self, - *, - database_key: "str", - table_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - ) -> "GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None": - """Update permission-based access control settings for a given table. Sets the access control for the given permissions. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - body: GsaUpdatePermissionCategoryAccessControlRequest - - Returns - ------- - GsaPermissionCategoriesAccessControlUpdateException | GsaPermissionCategoryAccessControlInfo | None - """ - data = self._update_table_permission_category_access_controls_with_http_info( - database_key, table_guid, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _update_table_permission_category_access_controls_with_http_info( - self, - database_key: "str", - table_guid: "str", - body: "Optional[GsaUpdatePermissionCategoryAccessControlRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_table_permission_category_access_controls" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_table_permission_category_access_controls'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'update_table_permission_category_access_controls'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["table-guid"] = params["table_guid"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaPermissionCategoryAccessControlInfo", - 400: "GsaPermissionCategoriesAccessControlUpdateException", - 403: None, - 404: None, - 422: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls", - "PATCH", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___unit_equivalents_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___unit_equivalents_api.py deleted file mode 100644 index d98ec3886..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___unit_equivalents_api.py +++ /dev/null @@ -1,245 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaUnitEquivalentsApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_unit_equivalents( - self, - *, - database_key: "str", - unit: "Optional[list[str]]" = None, - unit_system: "Optional[list[str]]" = None, - ) -> "GsaGetUnitEquivalentsException | GsaUnitEquivalentsInfo | None": - """Get unit equivalents - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - unit: list[str] - unit_system: list[str] - - Returns - ------- - GsaGetUnitEquivalentsException | GsaUnitEquivalentsInfo | None - """ - data = self._get_unit_equivalents_with_http_info( - database_key, unit, unit_system, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_unit_equivalents_with_http_info( - self, - database_key: "str", - unit: "Optional[list[str]]" = None, - unit_system: "Optional[list[str]]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "unit", - "unit_system", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_unit_equivalents" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_unit_equivalents'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - if "unit" in params and unit is not None: - query_params.append(("unit", params["unit"])) - collection_formats["unit"] = "multi" - if "unit_system" in params and unit_system is not None: - query_params.append(("unitSystem", params["unit_system"])) - collection_formats["unitSystem"] = "multi" - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitEquivalentsInfo", - 400: "GsaGetUnitEquivalentsException", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/unit-equivalents", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def set_unit_equivalents( - self, *, database_key: "str", body: "Optional[GsaSetUnitEquivalentsInfo]" = None - ) -> "GsaSetUnitEquivalentsException | GsaUnitEquivalentsInfo | None": - """Update one or more unit equivalents. Returns the unit equivalents that have been updated. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaSetUnitEquivalentsInfo - - Returns - ------- - GsaSetUnitEquivalentsException | GsaUnitEquivalentsInfo | None - """ - data = self._set_unit_equivalents_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _set_unit_equivalents_with_http_info( - self, database_key: "str", body: "Optional[GsaSetUnitEquivalentsInfo]" = None, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method set_unit_equivalents" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'set_unit_equivalents'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitEquivalentsInfo", - 400: "GsaSetUnitEquivalentsException", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/unit-equivalents:update", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___units_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___units_api.py index aa17c2e55..dfc3263b8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___units_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___units_api.py @@ -50,7 +50,7 @@ class SchemaUnitsApi(ApiBase): def create_unit( self, *, database_key: "str", body: "Optional[GsaCreateUnit]" = None - ) -> "GsaUnit | GsaUnitCreationException | None": + ) -> "GsaUnit | None": """Create a new unit. This method makes a synchronous HTTP request. @@ -58,12 +58,11 @@ def create_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateUnit Returns ------- - GsaUnit | GsaUnitCreationException | None + GsaUnit | None """ data = self._create_unit_with_http_info(database_key, body, _return_http_data_only=True) return data # type: ignore[no-any-return] @@ -117,7 +116,7 @@ def _create_unit_with_http_info( response_type_map: dict[int, Optional[str]] = { 201: "GsaUnit", - 400: "GsaUnitCreationException", + 400: None, 403: None, 404: None, } @@ -148,7 +147,6 @@ def create_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaCreateUnitSystem Returns @@ -232,9 +230,7 @@ def _create_unit_system_with_http_info( response_type_map=response_type_map, ) - def delete_unit( - self, *, database_key: "str", unit_guid: "str" - ) -> "GsaUnitDeletionException | None": + def delete_unit(self, *, database_key: "str", unit_guid: "str") -> "None": """Delete unit. This method makes a synchronous HTTP request. @@ -242,12 +238,11 @@ def delete_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns ------- - GsaUnitDeletionException | None + None """ data = self._delete_unit_with_http_info( database_key, unit_guid, _return_http_data_only=True @@ -298,12 +293,10 @@ def _delete_unit_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 400: "GsaUnitDeletionException", 200: None, + 400: None, 403: None, 404: None, } @@ -332,7 +325,6 @@ def delete_unit_system(self, *, database_key: "str", unit_system_guid: "str") -> Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str Returns @@ -424,7 +416,6 @@ def get_compatible_units( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns @@ -514,7 +505,6 @@ def get_unit(self, *, database_key: "str", unit_guid: "str") -> "GsaUnit | None" Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str Returns @@ -590,7 +580,7 @@ def _get_unit_with_http_info(self, database_key: "str", unit_guid: "str", **kwar def get_unit_conversions( self, *, database_key: "str", body: "Optional[GsaGetUnitConversionsRequest]" = None - ) -> "GsaUnitConversionsInfo | None": + ) -> "GsaUnitConversionsInfo": """Gets all the equivalent units and their conversion factors for the specified source units, including any errors that occurred. This method makes a synchronous HTTP request. @@ -598,12 +588,11 @@ def get_unit_conversions( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaGetUnitConversionsRequest Returns ------- - GsaUnitConversionsInfo | None + GsaUnitConversionsInfo """ data = self._get_unit_conversions_with_http_info( database_key, body, _return_http_data_only=True @@ -664,7 +653,6 @@ def _get_unit_conversions_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaUnitConversionsInfo", - 400: None, } return self.api_client.call_api( @@ -683,6 +671,97 @@ def _get_unit_conversions_with_http_info( response_type_map=response_type_map, ) + def get_unit_equivalents( + self, *, database_key: "str", unit_guid: "str" + ) -> "GsaUnitEquivalentsInfo | None": + """Get equivalent units (one per unit system) + + This method makes a synchronous HTTP request. + + Parameters + ---------- + database_key: str + unit_guid: str + + Returns + ------- + GsaUnitEquivalentsInfo | None + """ + data = self._get_unit_equivalents_with_http_info( + database_key, unit_guid, _return_http_data_only=True + ) + return data # type: ignore[no-any-return] + + def _get_unit_equivalents_with_http_info( + self, database_key: "str", unit_guid: "str", **kwargs: Any + ) -> Any: + all_params = [ + "database_key", + "unit_guid", + "_return_http_data_only", + "_preload_content", + "_request_timeout", + ] + + params = locals() + for key, val in params["kwargs"].items(): + if key not in all_params: + raise TypeError( + f"Got an unexpected keyword argument '{key}' to method get_unit_equivalents" + ) + params[key] = val + del params["kwargs"] + # verify the required parameter "database_key" is set + if "database_key" not in params or params["database_key"] is None: + raise ValueError( + "Missing the required parameter 'database_key' when calling 'get_unit_equivalents'" + ) + # verify the required parameter "unit_guid" is set + if "unit_guid" not in params or params["unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_guid' when calling 'get_unit_equivalents'" + ) + + collection_formats: dict[str, Any] = {} + + path_params: dict[str, Any] = {} + if "database_key" in params and database_key is not None: + path_params["database-key"] = params["database_key"] + if "unit_guid" in params and unit_guid is not None: + path_params["unit-guid"] = params["unit_guid"] + + query_params: list[Any] = [] + + header_params: dict[str, Any] = {} + + form_params: list[Any] = [] + local_var_files: dict[str, Any] = {} + + body_params = None + # HTTP header 'Accept' + header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + + response_type_map: dict[int, Optional[str]] = { + 200: "GsaUnitEquivalentsInfo", + 404: None, + } + + return self.api_client.call_api( + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units", + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + _return_http_data_only=params.get("_return_http_data_only"), + _preload_content=params.get("_preload_content", True), + _request_timeout=params.get("_request_timeout"), + collection_formats=collection_formats, + response_type_map=response_type_map, + ) + def get_unit_system( self, *, database_key: "str", unit_system_guid: "str" ) -> "GsaUnitSystem | None": @@ -693,7 +772,6 @@ def get_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str Returns @@ -783,7 +861,6 @@ def get_unit_systems(self, *, database_key: "str") -> "GsaUnitSystemsInfo | None Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -852,13 +929,7 @@ def _get_unit_systems_with_http_info(self, database_key: "str", **kwargs: Any) - response_type_map=response_type_map, ) - def get_unit_usages( - self, - *, - database_key: "str", - unit_guid: "str", - response_filters: "Optional[list[GsaUnitUsageType]]" = None, - ) -> "GsaUnitUsage | None": + def get_unit_usages(self, *, database_key: "str", unit_guid: "str") -> "GsaUnitUsage | None": """Get all usages of unit This method makes a synchronous HTTP request. @@ -866,31 +937,23 @@ def get_unit_usages( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str - response_filters: list[GsaUnitUsageType] - The unit usage types to include in the response. If none are provided, all types are included. Returns ------- GsaUnitUsage | None """ data = self._get_unit_usages_with_http_info( - database_key, unit_guid, response_filters, _return_http_data_only=True + database_key, unit_guid, _return_http_data_only=True ) return data # type: ignore[no-any-return] def _get_unit_usages_with_http_info( - self, - database_key: "str", - unit_guid: "str", - response_filters: "Optional[list[GsaUnitUsageType]]" = None, - **kwargs: Any, + self, database_key: "str", unit_guid: "str", **kwargs: Any ) -> Any: all_params = [ "database_key", "unit_guid", - "response_filters", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -924,9 +987,6 @@ def _get_unit_usages_with_http_info( path_params["unit-guid"] = params["unit_guid"] query_params: list[Any] = [] - if "response_filters" in params and response_filters is not None: - query_params.append(("response-filters", params["response_filters"])) - collection_formats["response-filters"] = "multi" header_params: dict[str, Any] = {} @@ -966,7 +1026,6 @@ def get_units(self, *, database_key: "str") -> "GsaUnitsInfo | None": Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -1033,32 +1092,51 @@ def _get_units_with_http_info(self, database_key: "str", **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_units_grouped_by_compatibility( - self, *, database_key: "str" - ) -> "GsaUnitsGroupingInfo | None": - """Get units grouped by compatibility, each grouping contains only compatible units + def set_unit_equivalent( + self, + *, + database_key: "str", + unit_guid: "str", + unit_system_guid: "str", + equivalent_unit_guid: "str", + ) -> "None": + """Set the equivalent unit for a given unit system This method makes a synchronous HTTP request. Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + unit_guid: str + unit_system_guid: str + equivalent_unit_guid: str Returns ------- - GsaUnitsGroupingInfo | None + None """ - data = self._get_units_grouped_by_compatibility_with_http_info( - database_key, _return_http_data_only=True + data = self._set_unit_equivalent_with_http_info( + database_key, + unit_guid, + unit_system_guid, + equivalent_unit_guid, + _return_http_data_only=True, ) return data # type: ignore[no-any-return] - def _get_units_grouped_by_compatibility_with_http_info( - self, database_key: "str", **kwargs: Any + def _set_unit_equivalent_with_http_info( + self, + database_key: "str", + unit_guid: "str", + unit_system_guid: "str", + equivalent_unit_guid: "str", + **kwargs: Any, ) -> Any: all_params = [ "database_key", + "unit_guid", + "unit_system_guid", + "equivalent_unit_guid", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -1068,14 +1146,29 @@ def _get_units_grouped_by_compatibility_with_http_info( for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_units_grouped_by_compatibility" + f"Got an unexpected keyword argument '{key}' to method set_unit_equivalent" ) params[key] = val del params["kwargs"] # verify the required parameter "database_key" is set if "database_key" not in params or params["database_key"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_units_grouped_by_compatibility'" + "Missing the required parameter 'database_key' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "unit_guid" is set + if "unit_guid" not in params or params["unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_guid' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "unit_system_guid" is set + if "unit_system_guid" not in params or params["unit_system_guid"] is None: + raise ValueError( + "Missing the required parameter 'unit_system_guid' when calling 'set_unit_equivalent'" + ) + # verify the required parameter "equivalent_unit_guid" is set + if "equivalent_unit_guid" not in params or params["equivalent_unit_guid"] is None: + raise ValueError( + "Missing the required parameter 'equivalent_unit_guid' when calling 'set_unit_equivalent'" ) collection_formats: dict[str, Any] = {} @@ -1083,6 +1176,12 @@ def _get_units_grouped_by_compatibility_with_http_info( path_params: dict[str, Any] = {} if "database_key" in params and database_key is not None: path_params["database-key"] = params["database_key"] + if "unit_guid" in params and unit_guid is not None: + path_params["unit-guid"] = params["unit_guid"] + if "unit_system_guid" in params and unit_system_guid is not None: + path_params["unit-system-guid"] = params["unit_system_guid"] + if "equivalent_unit_guid" in params and equivalent_unit_guid is not None: + path_params["equivalent-unit-guid"] = params["equivalent_unit_guid"] query_params: list[Any] = [] @@ -1092,17 +1191,15 @@ def _get_units_grouped_by_compatibility_with_http_info( local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaUnitsGroupingInfo", + 200: None, 404: None, } return self.api_client.call_api( - "/v1alpha/databases/{database-key}/units-grouped-by-compatibility", - "GET", + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units/unit-system/{unit-system-guid}/equivalent-unit/{equivalent-unit-guid}:set-equivalent-unit", + "POST", path_params, query_params, header_params, @@ -1118,7 +1215,7 @@ def _get_units_grouped_by_compatibility_with_http_info( def update_unit( self, *, database_key: "str", unit_guid: "str", body: "Optional[GsaUpdateUnit]" = None - ) -> "GsaUnit | GsaUnitUpdateException | None": + ) -> "GsaUnit | None": """Update unit. This method makes a synchronous HTTP request. @@ -1126,13 +1223,12 @@ def update_unit( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_guid: str body: GsaUpdateUnit Returns ------- - GsaUnit | GsaUnitUpdateException | None + GsaUnit | None """ data = self._update_unit_with_http_info( database_key, unit_guid, body, _return_http_data_only=True @@ -1200,7 +1296,7 @@ def _update_unit_with_http_info( response_type_map: dict[int, Optional[str]] = { 200: "GsaUnit", - 400: "GsaUnitUpdateException", + 400: None, 403: None, 404: None, } @@ -1235,7 +1331,6 @@ def update_unit_system( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) unit_system_guid: str body: GsaUpdateUnitSystem @@ -1331,99 +1426,3 @@ def _update_unit_system_with_http_info( collection_formats=collection_formats, response_type_map=response_type_map, ) - - def validate_unit_equation( - self, *, database_key: "str", body: "Optional[GsaValidateUnitEquationRequest]" = None - ) -> "GsaValidateUnitEquationResponse | None": - """Check whether the unit equation is valid. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaValidateUnitEquationRequest - - Returns - ------- - GsaValidateUnitEquationResponse | None - """ - data = self._validate_unit_equation_with_http_info( - database_key, body, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _validate_unit_equation_with_http_info( - self, - database_key: "str", - body: "Optional[GsaValidateUnitEquationRequest]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method validate_unit_equation" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'validate_unit_equation'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["database-key"] = params["database_key"] - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - if "body" in params and body is not None: - body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaValidateUnitEquationResponse", - 403: None, - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{database-key}/units:validate-equation", - "POST", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___xy_chart_templates_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___xy_chart_templates_api.py deleted file mode 100644 index 99dbbfaee..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___xy_chart_templates_api.py +++ /dev/null @@ -1,309 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ApiBase - -if TYPE_CHECKING: - import pathlib - - from ..models import * - - -class SchemaXYChartTemplatesApi(ApiBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def get_template( - self, - *, - database_key: "str", - table_guid: "str", - template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - ) -> "GsaXYChartTemplate | None": - """Get XY chart template in database. - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - template_guid: str - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - - Returns - ------- - GsaXYChartTemplate | None - """ - data = self._get_template_with_http_info( - database_key, - table_guid, - template_guid, - mode, - x_ansys_vc_mode, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_template_with_http_info( - self, - database_key: "str", - table_guid: "str", - template_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "template_guid", - "mode", - "x_ansys_vc_mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_template" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_template'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_template'" - ) - # verify the required parameter "template_guid" is set - if "template_guid" not in params or params["template_guid"] is None: - raise ValueError( - "Missing the required parameter 'template_guid' when calling 'get_template'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["tableGuid"] = params["table_guid"] - if "template_guid" in params and template_guid is not None: - path_params["templateGuid"] = params["template_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaXYChartTemplate", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates/{templateGuid}", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_templates( - self, - *, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - page_size: "Optional[int]" = 10, - page: "Optional[int]" = 1, - ) -> "GsaXYChartTemplatesInfo | None": - """Get XY chart templates in database - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - page_size: int - page: int - - Returns - ------- - GsaXYChartTemplatesInfo | None - """ - data = self._get_templates_with_http_info( - database_key, - table_guid, - mode, - x_ansys_vc_mode, - page_size, - page, - _return_http_data_only=True, - ) - return data # type: ignore[no-any-return] - - def _get_templates_with_http_info( - self, - database_key: "str", - table_guid: "str", - mode: "Optional[str]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - page_size: "Optional[int]" = 10, - page: "Optional[int]" = 1, - **kwargs: Any, - ) -> Any: - all_params = [ - "database_key", - "table_guid", - "mode", - "x_ansys_vc_mode", - "page_size", - "page", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_templates" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_templates'" - ) - # verify the required parameter "table_guid" is set - if "table_guid" not in params or params["table_guid"] is None: - raise ValueError( - "Missing the required parameter 'table_guid' when calling 'get_templates'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - if "table_guid" in params and table_guid is not None: - path_params["tableGuid"] = params["table_guid"] - - query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) - if "page_size" in params and page_size is not None: - query_params.append(("pageSize", params["page_size"])) - if "page" in params and page is not None: - query_params.append(("page", params["page"])) - - header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaXYChartTemplatesInfo", - 404: None, - } - - return self.api_client.call_api( - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema_api.py index bd3c6a37c..66eaae760 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema_api.py @@ -48,25 +48,27 @@ class SchemaApi(ApiBase): Ref: https://github.com/swagger-api/swagger-codegen """ - def get_version(self) -> "GsaMiVersion": - """Returns the currently running MI version to the caller. + def get_security_attribute_groupings(self) -> "dict[str, list[GsaSecurityAttributeGrouping]]": + """Gets all security attribute groupings for a given database. This method makes a synchronous HTTP request. Returns ------- - GsaMiVersion + dict[str, list[GsaSecurityAttributeGrouping]] """ - data = self._get_version_with_http_info(_return_http_data_only=True) + data = self._get_security_attribute_groupings_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_version_with_http_info(self, **kwargs: Any) -> Any: + def _get_security_attribute_groupings_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_version") + raise TypeError( + f"Got an unexpected keyword argument '{key}' to method get_security_attribute_groupings" + ) params[key] = val del params["kwargs"] @@ -86,11 +88,11 @@ def _get_version_with_http_info(self, **kwargs: Any) -> Any: header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaMiVersion", + 200: "dict(str, list[GsaSecurityAttributeGrouping])", } return self.api_client.call_api( - "/v1alpha/schema/mi-version", + "/v1alpha/security-attribute-groupings", "GET", path_params, query_params, @@ -105,56 +107,25 @@ def _get_version_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def resolve_link_targets( - self, - *, - body: "Optional[GsaResolveLinkTargetsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - ) -> "GsaResolveLinkTargetsInfo | None": - """Gets all target tables that match the provided link target, for each target. There could be several matches or no matches for each link target. For example if two databases are loaded with the same databaseGuid and the databaseVersionGuid isn't specified, or if the databaseGuid and databaseVersionGuid are not specified and the tableGuid matches in several databases. There could be no matches if the target database is not loaded. + def get_version(self) -> "GsaMiVersion": + """Returns the currently running MI version to the caller. This method makes a synchronous HTTP request. - Parameters - ---------- - body: GsaResolveLinkTargetsRequest - x_ansys_vc_mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. - mode: str - The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header. - Returns ------- - GsaResolveLinkTargetsInfo | None + GsaMiVersion """ - data = self._resolve_link_targets_with_http_info( - body, x_ansys_vc_mode, mode, _return_http_data_only=True - ) + data = self._get_version_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _resolve_link_targets_with_http_info( - self, - body: "Optional[GsaResolveLinkTargetsRequest]" = None, - x_ansys_vc_mode: "Optional[str]" = None, - mode: "Optional[str]" = None, - **kwargs: Any, - ) -> Any: - all_params = [ - "body", - "x_ansys_vc_mode", - "mode", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + def _get_version_with_http_info(self, **kwargs: Any) -> Any: + all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method resolve_link_targets" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_version") params[key] = val del params["kwargs"] @@ -163,35 +134,23 @@ def _resolve_link_targets_with_http_info( path_params: dict[str, Any] = {} query_params: list[Any] = [] - if "mode" in params and mode is not None: - query_params.append(("mode", params["mode"])) header_params: dict[str, Any] = {} - if "x_ansys_vc_mode" in params and x_ansys_vc_mode is not None: - header_params["X-Ansys-VC-Mode"] = params["x_ansys_vc_mode"] form_params: list[Any] = [] local_var_files: dict[str, Any] = {} body_params = None - if "body" in params and body is not None: - body_params = params["body"] # HTTP header 'Accept' header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' - header_params["Content-Type"] = self.api_client.select_header_content_type( - ["application/json-patch+json", "application/json", "text/json", "application/*+json"] - ) - response_type_map: dict[int, Optional[str]] = { - 200: "GsaResolveLinkTargetsInfo", - 400: None, + 200: "GsaMiVersion", } return self.api_client.call_api( - "/v1alpha/schema:resolve-link-targets", - "POST", + "/v1alpha/schema/mi-version", + "GET", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/search_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/search_api.py index eb2f930fd..41df91497 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/search_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/search_api.py @@ -63,7 +63,6 @@ def database_search( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) body: GsaSearchRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -177,9 +176,7 @@ def database_search_in_table_with_guid( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_guid: str - See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables) body: GsaSearchRequest x_ansys_vc_mode: str The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string. @@ -302,7 +299,6 @@ def database_search_in_table_with_identity( Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) table_identity: int body: GsaSearchRequest x_ansys_vc_mode: str diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___security_groups_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/selection_searches_api.py similarity index 64% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___security_groups_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/selection_searches_api.py index 7bef32244..f27981d9d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/schema___security_groups_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/selection_searches_api.py @@ -41,68 +41,48 @@ from ..models import * -class SchemaSecurityGroupsApi(ApiBase): +class SelectionSearchesApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def add_database_security_groups( - self, *, database_key: "str", body: "Optional[GsaAddDatabaseSecurityGroups]" = None - ) -> "GsaDatabaseSecurityGroups | None": - """Adds security groups for a specific database. + def create_search( + self, *, body: "Optional[GsaCreateSearchRequest]" = None + ) -> "GsaSelectionSearch | None": + """Creates a new search with the specified properties. This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaAddDatabaseSecurityGroups + body: GsaCreateSearchRequest Returns ------- - GsaDatabaseSecurityGroups | None + GsaSelectionSearch | None """ - data = self._add_database_security_groups_with_http_info( - database_key, body, _return_http_data_only=True - ) + data = self._create_search_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _add_database_security_groups_with_http_info( - self, - database_key: "str", - body: "Optional[GsaAddDatabaseSecurityGroups]" = None, - **kwargs: Any, + def _create_search_with_http_info( + self, body: "Optional[GsaCreateSearchRequest]" = None, **kwargs: Any ) -> Any: - all_params = [ - "database_key", - "body", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method add_database_security_groups" + f"Got an unexpected keyword argument '{key}' to method create_search" ) params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'add_database_security_groups'" - ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] query_params: list[Any] = [] @@ -115,7 +95,9 @@ def _add_database_security_groups_with_http_info( if "body" in params and body is not None: body_params = params["body"] # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( @@ -123,15 +105,13 @@ def _add_database_security_groups_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroups", - 201: None, + 201: "GsaSelectionSearch", 400: None, 403: None, - 409: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", + "/v1alpha/selection-searches", "POST", path_params, query_params, @@ -146,33 +126,49 @@ def _add_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def get_database_security_groups(self) -> "GsaDatabaseSecurityGroupsInfo | None": - """Returns the prevailing security groups defined for each database. + def delete_search(self, *, search_identifier: "str") -> "None": + """Delete an existing selection search. This method makes a synchronous HTTP request. + Parameters + ---------- + search_identifier: str + Returns ------- - GsaDatabaseSecurityGroupsInfo | None + None """ - data = self._get_database_security_groups_with_http_info(_return_http_data_only=True) + data = self._delete_search_with_http_info(search_identifier, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] + def _delete_search_with_http_info(self, search_identifier: "str", **kwargs: Any) -> Any: + all_params = [ + "search_identifier", + "_return_http_data_only", + "_preload_content", + "_request_timeout", + ] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_database_security_groups" + f"Got an unexpected keyword argument '{key}' to method delete_search" ) params[key] = val del params["kwargs"] + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: + raise ValueError( + "Missing the required parameter 'search_identifier' when calling 'delete_search'" + ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -182,17 +178,16 @@ def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroupsInfo", + 200: None, 403: None, + 404: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases", - "GET", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "DELETE", path_params, query_params, header_params, @@ -206,29 +201,25 @@ def _get_database_security_groups_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_default_fallback_security_groups(self) -> "GsaDefaultFallbackSecurityGroups | None": - """Returns the default fallback (global) security groups. + def get_all(self) -> "None | list[GsaSelectionSearch]": + """Returns all searches visible to the calling user. This method makes a synchronous HTTP request. Returns ------- - GsaDefaultFallbackSecurityGroups | None + None | list[GsaSelectionSearch] """ - data = self._get_default_fallback_security_groups_with_http_info( - _return_http_data_only=True - ) + data = self._get_all_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> Any: + def _get_all_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_default_fallback_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_all") params[key] = val del params["kwargs"] @@ -245,15 +236,17 @@ def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> body_params = None # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDefaultFallbackSecurityGroups", + 200: "list[GsaSelectionSearch]", 403: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/defaultFallback", + "/v1alpha/selection-searches", "GET", path_params, query_params, @@ -268,30 +261,25 @@ def _get_default_fallback_security_groups_with_http_info(self, **kwargs: Any) -> response_type_map=response_type_map, ) - def remove_database_security_groups(self, *, database_key: "str") -> "None": - """Deletes the security groups defined for a specific database. + def get_search(self, *, search_identifier: "str") -> "GsaSelectionSearch | None": + """Returns the given search if it exists and the calling user has access to it This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) + search_identifier: str Returns ------- - None + GsaSelectionSearch | None """ - data = self._remove_database_security_groups_with_http_info( - database_key, _return_http_data_only=True - ) + data = self._get_search_with_http_info(search_identifier, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _remove_database_security_groups_with_http_info( - self, database_key: "str", **kwargs: Any - ) -> Any: + def _get_search_with_http_info(self, search_identifier: "str", **kwargs: Any) -> Any: all_params = [ - "database_key", + "search_identifier", "_return_http_data_only", "_preload_content", "_request_timeout", @@ -300,22 +288,20 @@ def _remove_database_security_groups_with_http_info( params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method remove_database_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method get_search") params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'remove_database_security_groups'" + "Missing the required parameter 'search_identifier' when calling 'get_search'" ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -325,17 +311,21 @@ def _remove_database_security_groups_with_http_info( local_var_files: dict[str, Any] = {} body_params = None + # HTTP header 'Accept' + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: None, - 204: None, + 200: "GsaSelectionSearch", 403: None, 404: None, + 410: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", - "DELETE", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "GET", path_params, query_params, header_params, @@ -349,36 +339,32 @@ def _remove_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def update_database_security_groups( - self, *, database_key: "str", body: "Optional[GsaUpdateDatabaseSecurityGroups]" = None - ) -> "GsaDatabaseSecurityGroups | None": - """Updates the security groups for a specific database. + def save_search( + self, *, search_identifier: "str", body: "Optional[GsaSaveSearchRequest]" = None + ) -> "None": + """If the search exists, updates the properties of the search. This will overwrite all current properties. If the search does not exist or the calling user does not have access to it, returns '404 not found' response. This method makes a synchronous HTTP request. Parameters ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - body: GsaUpdateDatabaseSecurityGroups + search_identifier: str + body: GsaSaveSearchRequest Returns ------- - GsaDatabaseSecurityGroups | None + None """ - data = self._update_database_security_groups_with_http_info( - database_key, body, _return_http_data_only=True + data = self._save_search_with_http_info( + search_identifier, body, _return_http_data_only=True ) return data # type: ignore[no-any-return] - def _update_database_security_groups_with_http_info( - self, - database_key: "str", - body: "Optional[GsaUpdateDatabaseSecurityGroups]" = None, - **kwargs: Any, + def _save_search_with_http_info( + self, search_identifier: "str", body: "Optional[GsaSaveSearchRequest]" = None, **kwargs: Any ) -> Any: all_params = [ - "database_key", + "search_identifier", "body", "_return_http_data_only", "_preload_content", @@ -388,22 +374,20 @@ def _update_database_security_groups_with_http_info( params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_database_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method save_search") params[key] = val del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: + # verify the required parameter "search_identifier" is set + if "search_identifier" not in params or params["search_identifier"] is None: raise ValueError( - "Missing the required parameter 'database_key' when calling 'update_database_security_groups'" + "Missing the required parameter 'search_identifier' when calling 'save_search'" ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] + if "search_identifier" in params and search_identifier is not None: + path_params["searchIdentifier"] = params["search_identifier"] query_params: list[Any] = [] @@ -415,24 +399,21 @@ def _update_database_security_groups_with_http_info( body_params = None if "body" in params and body is not None: body_params = params["body"] - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) - # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( ["application/json-patch+json", "application/json", "text/json", "application/*+json"] ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDatabaseSecurityGroups", + 200: None, 400: None, 403: None, 404: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/databases/{databaseKey}", - "PATCH", + "/v1alpha/selection-searches/search/{searchIdentifier}", + "PUT", path_params, query_params, header_params, @@ -446,37 +427,33 @@ def _update_database_security_groups_with_http_info( response_type_map=response_type_map, ) - def update_default_fallback_security_groups( - self, *, body: "Optional[GsaUpdateDefaultFallbackSecurityGroups]" = None - ) -> "GsaDefaultFallbackSecurityGroups | None": - """Updates the default fallback (global) security groups. + def search( + self, *, body: "Optional[GsaFindSearchRequest]" = None + ) -> "GsaSelectionSearch | None": + """Retrieves a collection of searches that match the specified criteria. This method makes a synchronous HTTP request. Parameters ---------- - body: GsaUpdateDefaultFallbackSecurityGroups + body: GsaFindSearchRequest Returns ------- - GsaDefaultFallbackSecurityGroups | None + GsaSelectionSearch | None """ - data = self._update_default_fallback_security_groups_with_http_info( - body, _return_http_data_only=True - ) + data = self._search_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _update_default_fallback_security_groups_with_http_info( - self, body: "Optional[GsaUpdateDefaultFallbackSecurityGroups]" = None, **kwargs: Any + def _search_with_http_info( + self, body: "Optional[GsaFindSearchRequest]" = None, **kwargs: Any ) -> Any: all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method update_default_fallback_security_groups" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method search") params[key] = val del params["kwargs"] @@ -495,7 +472,9 @@ def _update_default_fallback_security_groups_with_http_info( if "body" in params and body is not None: body_params = params["body"] # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) # HTTP header 'Content-Type' header_params["Content-Type"] = self.api_client.select_header_content_type( @@ -503,14 +482,14 @@ def _update_default_fallback_security_groups_with_http_info( ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaDefaultFallbackSecurityGroups", + 200: "GsaSelectionSearch", 400: None, 403: None, } return self.api_client.call_api( - "/v1alpha/securityGroups/defaultFallback", - "PATCH", + "/v1alpha/selection-searches/search", + "POST", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/currencies_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/server_manager_api.py similarity index 71% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/currencies_api.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/server_manager_api.py index 97709a8ee..267d55096 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/currencies_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/server_manager_api.py @@ -41,33 +41,33 @@ from ..models import * -class CurrenciesApi(ApiBase): +class ServerManagerApi(ApiBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen """ - def get_currencies(self) -> "GsaCurrenciesInfo | None": - """All the currencies configured on the server. + def get_smtp_properties(self) -> "GsaSmtpProperties": + """get_smtp_properties This method makes a synchronous HTTP request. Returns ------- - GsaCurrenciesInfo | None + GsaSmtpProperties """ - data = self._get_currencies_with_http_info(_return_http_data_only=True) + data = self._get_smtp_properties_with_http_info(_return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: + def _get_smtp_properties_with_http_info(self, **kwargs: Any) -> Any: all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_currencies" + f"Got an unexpected keyword argument '{key}' to method get_smtp_properties" ) params[key] = val del params["kwargs"] @@ -85,15 +85,16 @@ def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: body_params = None # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + header_params["Accept"] = self.api_client.select_header_accept( + ["text/plain", "application/json", "text/json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaCurrenciesInfo", - 403: None, + 200: "GsaSmtpProperties", } return self.api_client.call_api( - "/v1alpha/currencies", + "/v1alpha/serverManager/email", "GET", path_params, query_params, @@ -108,49 +109,35 @@ def _get_currencies_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_currency(self, *, currency_code: "str") -> "GsaCurrency | None": - """Gets the currency with the specified code. + def put(self, *, body: "Optional[GsaSmtpProperties]" = None) -> "None": + """put This method makes a synchronous HTTP request. Parameters ---------- - currency_code: str + body: GsaSmtpProperties Returns ------- - GsaCurrency | None + None """ - data = self._get_currency_with_http_info(currency_code, _return_http_data_only=True) + data = self._put_with_http_info(body, _return_http_data_only=True) return data # type: ignore[no-any-return] - def _get_currency_with_http_info(self, currency_code: "str", **kwargs: Any) -> Any: - all_params = [ - "currency_code", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] + def _put_with_http_info(self, body: "Optional[GsaSmtpProperties]" = None, **kwargs: Any) -> Any: + all_params = ["body", "_return_http_data_only", "_preload_content", "_request_timeout"] params = locals() for key, val in params["kwargs"].items(): if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_currency" - ) + raise TypeError(f"Got an unexpected keyword argument '{key}' to method put") params[key] = val del params["kwargs"] - # verify the required parameter "currency_code" is set - if "currency_code" not in params or params["currency_code"] is None: - raise ValueError( - "Missing the required parameter 'currency_code' when calling 'get_currency'" - ) collection_formats: dict[str, Any] = {} path_params: dict[str, Any] = {} - if "currency_code" in params and currency_code is not None: - path_params["currencyCode"] = params["currency_code"] query_params: list[Any] = [] @@ -160,18 +147,20 @@ def _get_currency_with_http_info(self, currency_code: "str", **kwargs: Any) -> A local_var_files: dict[str, Any] = {} body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + if "body" in params and body is not None: + body_params = params["body"] + # HTTP header 'Content-Type' + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json-patch+json", "application/json", "text/json", "application/*+json"] + ) response_type_map: dict[int, Optional[str]] = { - 200: "GsaCurrency", - 403: None, - 404: None, + 200: None, } return self.api_client.call_api( - "/v1alpha/currencies/{currencyCode}", - "GET", + "/v1alpha/serverManager/email", + "PUT", path_params, query_params, header_params, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/status_api.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/status_api.py index 03ea6d62d..1a9c5abcb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/status_api.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/api/status_api.py @@ -111,7 +111,6 @@ def get_database_status(self, *, database_key: "str") -> "GsaDatabaseStatusInfor Parameters ---------- database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) Returns ------- @@ -242,157 +241,6 @@ def _get_search_cluster_status_with_http_info(self, **kwargs: Any) -> Any: response_type_map=response_type_map, ) - def get_search_index_status_async( - self, *, database_key: "str", include_error_details: "Optional[bool]" = True - ) -> "GsaSearchIndexStatus | None": - """Returns information about the Search Index status - - This method makes a synchronous HTTP request. - - Parameters - ---------- - database_key: str - See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases) - include_error_details: bool - - Returns - ------- - GsaSearchIndexStatus | None - """ - data = self._get_search_index_status_async_with_http_info( - database_key, include_error_details, _return_http_data_only=True - ) - return data # type: ignore[no-any-return] - - def _get_search_index_status_async_with_http_info( - self, database_key: "str", include_error_details: "Optional[bool]" = True, **kwargs: Any - ) -> Any: - all_params = [ - "database_key", - "include_error_details", - "_return_http_data_only", - "_preload_content", - "_request_timeout", - ] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_index_status_async" - ) - params[key] = val - del params["kwargs"] - # verify the required parameter "database_key" is set - if "database_key" not in params or params["database_key"] is None: - raise ValueError( - "Missing the required parameter 'database_key' when calling 'get_search_index_status_async'" - ) - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - if "database_key" in params and database_key is not None: - path_params["databaseKey"] = params["database_key"] - - query_params: list[Any] = [] - if "include_error_details" in params and include_error_details is not None: - query_params.append(("includeErrorDetails", params["include_error_details"])) - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchIndexStatus", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/status/databases/{databaseKey}/searchIndexStatus", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - - def get_search_service_status_async(self) -> "GsaSearchServiceStatus | None": - """Returns information about the Search Service status - - This method makes a synchronous HTTP request. - - Returns - ------- - GsaSearchServiceStatus | None - """ - data = self._get_search_service_status_async_with_http_info(_return_http_data_only=True) - return data # type: ignore[no-any-return] - - def _get_search_service_status_async_with_http_info(self, **kwargs: Any) -> Any: - all_params = ["_return_http_data_only", "_preload_content", "_request_timeout"] - - params = locals() - for key, val in params["kwargs"].items(): - if key not in all_params: - raise TypeError( - f"Got an unexpected keyword argument '{key}' to method get_search_service_status_async" - ) - params[key] = val - del params["kwargs"] - - collection_formats: dict[str, Any] = {} - - path_params: dict[str, Any] = {} - - query_params: list[Any] = [] - - header_params: dict[str, Any] = {} - - form_params: list[Any] = [] - local_var_files: dict[str, Any] = {} - - body_params = None - # HTTP header 'Accept' - header_params["Accept"] = self.api_client.select_header_accept( - ["text/plain", "application/json", "text/json"] - ) - - response_type_map: dict[int, Optional[str]] = { - 200: "GsaSearchServiceStatus", - 403: None, - } - - return self.api_client.call_api( - "/v1alpha/status/searchServiceStatus", - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - _return_http_data_only=params.get("_return_http_data_only"), - _preload_content=params.get("_preload_content", True), - _request_timeout=params.get("_request_timeout"), - collection_formats=collection_formats, - response_type_map=response_type_map, - ) - def get_status(self) -> "list[GsaDatabaseStatusInformation]": """Returns status information for all databases diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/__init__.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/__init__.py index 5bbc9c6d7..606f2dd88 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/__init__.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/__init__.py @@ -51,47 +51,14 @@ from .granta_mi_record_property_fake_attribute_identities import ( GrantaMIRecordPropertyFakeAttributeIdentities, ) -from .granta_mi_search_free_text_identifiers import GrantaMISearchFreeTextIdentifiers from .gsa_about_attribute_cannot_be_meta_attribute_error_detail import ( GsaAboutAttributeCannotBeMetaAttributeErrorDetail, ) -from .gsa_access_control_categories_info import GsaAccessControlCategoriesInfo -from .gsa_access_control_category import GsaAccessControlCategory -from .gsa_access_control_category_creation_exception import ( - GsaAccessControlCategoryCreationException, -) -from .gsa_access_control_category_error_detail import GsaAccessControlCategoryErrorDetail -from .gsa_access_control_category_error_reason import GsaAccessControlCategoryErrorReason -from .gsa_access_control_category_include import GsaAccessControlCategoryInclude -from .gsa_access_control_category_no_such_entity_type import ( - GsaAccessControlCategoryNoSuchEntityType, -) -from .gsa_access_control_category_table_mapping import GsaAccessControlCategoryTableMapping -from .gsa_access_control_category_update_exception import GsaAccessControlCategoryUpdateException -from .gsa_access_control_info import GsaAccessControlInfo -from .gsa_access_control_mode import GsaAccessControlMode -from .gsa_access_control_mode_info import GsaAccessControlModeInfo -from .gsa_activity_log_application_name_filter import GsaActivityLogApplicationNameFilter -from .gsa_activity_log_application_names_collection_filter import ( - GsaActivityLogApplicationNamesCollectionFilter, -) -from .gsa_activity_log_collection_match_type import GsaActivityLogCollectionMatchType -from .gsa_activity_log_database_key_filter import GsaActivityLogDatabaseKeyFilter -from .gsa_activity_log_date_filter import GsaActivityLogDateFilter -from .gsa_activity_log_entries_filter import GsaActivityLogEntriesFilter -from .gsa_activity_log_entries_info import GsaActivityLogEntriesInfo -from .gsa_activity_log_entry import GsaActivityLogEntry -from .gsa_activity_log_match_type import GsaActivityLogMatchType -from .gsa_activity_log_usage_mode import GsaActivityLogUsageMode -from .gsa_activity_log_usage_mode_filter import GsaActivityLogUsageModeFilter -from .gsa_activity_log_username_filter import GsaActivityLogUsernameFilter from .gsa_add_database import GsaAddDatabase from .gsa_add_database_issue_type import GsaAddDatabaseIssueType -from .gsa_add_database_security_groups import GsaAddDatabaseSecurityGroups from .gsa_add_database_validation_issue import GsaAddDatabaseValidationIssue from .gsa_add_database_validation_result import GsaAddDatabaseValidationResult from .gsa_add_record_history_to_subset import GsaAddRecordHistoryToSubset -from .gsa_additional_sql_parameters import GsaAdditionalSqlParameters from .gsa_aggregation import GsaAggregation from .gsa_aggregation_criterion import GsaAggregationCriterion from .gsa_aggregation_datum import GsaAggregationDatum @@ -114,26 +81,16 @@ from .gsa_append_point_values import GsaAppendPointValues from .gsa_applicable_datum import GsaApplicableDatum from .gsa_applications_info import GsaApplicationsInfo -from .gsa_apply_options import GsaApplyOptions -from .gsa_association_chain_create_put_layout_item import GsaAssociationChainCreatePutLayoutItem from .gsa_attribute import GsaAttribute from .gsa_attribute_aggregation import GsaAttributeAggregation from .gsa_attribute_aggregation_criterion import GsaAttributeAggregationCriterion from .gsa_attribute_aggregation_exists_criterion import GsaAttributeAggregationExistsCriterion from .gsa_attribute_aggregation_type import GsaAttributeAggregationType from .gsa_attribute_aggregation_value_criterion import GsaAttributeAggregationValueCriterion -from .gsa_attribute_already_specified_smart_attributes_error_detail import ( - GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail, -) -from .gsa_attribute_based_access_control_info import GsaAttributeBasedAccessControlInfo -from .gsa_attribute_create_put_layout_item import GsaAttributeCreatePutLayoutItem from .gsa_attribute_creation_exception import GsaAttributeCreationException from .gsa_attribute_criterion import GsaAttributeCriterion from .gsa_attribute_criterion_type import GsaAttributeCriterionType from .gsa_attribute_deletion_exception import GsaAttributeDeletionException -from .gsa_attribute_discrete_type_mismatch_error_detail import ( - GsaAttributeDiscreteTypeMismatchErrorDetail, -) from .gsa_attribute_error_detail import GsaAttributeErrorDetail from .gsa_attribute_error_reason import GsaAttributeErrorReason from .gsa_attribute_exists_aggregation import GsaAttributeExistsAggregation @@ -145,22 +102,12 @@ from .gsa_attribute_matches_criterion import GsaAttributeMatchesCriterion from .gsa_attribute_no_such_entity_type import GsaAttributeNoSuchEntityType from .gsa_attribute_not_applicable_criterion import GsaAttributeNotApplicableCriterion -from .gsa_attribute_not_on_table_error_detail import GsaAttributeNotOnTableErrorDetail -from .gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail, -) -from .gsa_attribute_pair_type_mismatch_smart_attributes_error_detail import ( - GsaAttributePairTypeMismatchSmartAttributesErrorDetail, -) from .gsa_attribute_reference import GsaAttributeReference from .gsa_attribute_scale_type import GsaAttributeScaleType from .gsa_attribute_sort_criterion import GsaAttributeSortCriterion from .gsa_attribute_threshold_type import GsaAttributeThresholdType from .gsa_attribute_to_export import GsaAttributeToExport from .gsa_attribute_type import GsaAttributeType -from .gsa_attribute_type_not_supported_smart_attributes_error_detail import ( - GsaAttributeTypeNotSupportedSmartAttributesErrorDetail, -) from .gsa_attribute_usage_data_modification_error_detail import ( GsaAttributeUsageDataModificationErrorDetail, ) @@ -168,61 +115,31 @@ from .gsa_attribute_value_aggregation import GsaAttributeValueAggregation from .gsa_attributes_info import GsaAttributesInfo from .gsa_axis_name import GsaAxisName -from .gsa_blob_info_dto import GsaBlobInfoDto from .gsa_boolean_criterion import GsaBooleanCriterion from .gsa_boost_by_guid import GsaBoostByGuid from .gsa_boost_by_identity import GsaBoostByIdentity -from .gsa_bracket_mismatch_unit_equation_error_detail import ( - GsaBracketMismatchUnitEquationErrorDetail, -) from .gsa_bulk_info import GsaBulkInfo from .gsa_bulk_request import GsaBulkRequest from .gsa_bulk_request_http_method import GsaBulkRequestHttpMethod from .gsa_bulk_request_item import GsaBulkRequestItem from .gsa_bulk_response_item import GsaBulkResponseItem from .gsa_calendar_interval import GsaCalendarInterval -from .gsa_category_replace_permission_category_error_detail import ( - GsaCategoryReplacePermissionCategoryErrorDetail, -) -from .gsa_chart_data import GsaChartData -from .gsa_chart_data_type import GsaChartDataType -from .gsa_circular_reference_folder_move_error_detail import ( - GsaCircularReferenceFolderMoveErrorDetail, -) -from .gsa_code_missing_currency_error_detail import GsaCodeMissingCurrencyErrorDetail -from .gsa_code_whitespace_currency_error_detail import GsaCodeWhitespaceCurrencyErrorDetail -from .gsa_config_invalid_json_file_error_detail import GsaConfigInvalidJsonFileErrorDetail from .gsa_configuration import GsaConfiguration -from .gsa_configuration_details import GsaConfigurationDetails from .gsa_configurations_info import GsaConfigurationsInfo from .gsa_connection_details import GsaConnectionDetails from .gsa_constant import GsaConstant -from .gsa_constant_creation_exception import GsaConstantCreationException from .gsa_constant_deletion_exception import GsaConstantDeletionException -from .gsa_constant_error_detail import GsaConstantErrorDetail -from .gsa_constant_error_reason import GsaConstantErrorReason -from .gsa_constant_update_exception import GsaConstantUpdateException -from .gsa_constant_usage_data_modification_error_detail import ( - GsaConstantUsageDataModificationErrorDetail, -) from .gsa_constants_info import GsaConstantsInfo -from .gsa_continuous_quality_system import GsaContinuousQualitySystem from .gsa_continuous_range import GsaContinuousRange from .gsa_copy_record_history import GsaCopyRecordHistory -from .gsa_create_access_control_category import GsaCreateAccessControlCategory -from .gsa_create_access_control_category_table_mapping import ( - GsaCreateAccessControlCategoryTableMapping, -) from .gsa_create_attribute import GsaCreateAttribute from .gsa_create_attribute_link_pair import GsaCreateAttributeLinkPair from .gsa_create_axis_name import GsaCreateAxisName from .gsa_create_configuration import GsaCreateConfiguration from .gsa_create_constant import GsaCreateConstant from .gsa_create_continuous_range import GsaCreateContinuousRange -from .gsa_create_cross_database_link_target import GsaCreateCrossDatabaseLinkTarget from .gsa_create_cross_database_record_link_group import GsaCreateCrossDatabaseRecordLinkGroup from .gsa_create_data_rule import GsaCreateDataRule -from .gsa_create_data_update_server_api_request import GsaCreateDataUpdateServerApiRequest from .gsa_create_date_time_attribute import GsaCreateDateTimeAttribute from .gsa_create_discrete_attribute import GsaCreateDiscreteAttribute from .gsa_create_discrete_functional_attribute import GsaCreateDiscreteFunctionalAttribute @@ -240,6 +157,7 @@ from .gsa_create_discrete_parameter_value import GsaCreateDiscreteParameterValue from .gsa_create_discrete_range import GsaCreateDiscreteRange from .gsa_create_discrete_type import GsaCreateDiscreteType +from .gsa_create_dynamic_record_link_group import GsaCreateDynamicRecordLinkGroup from .gsa_create_expression import GsaCreateExpression from .gsa_create_file_attribute import GsaCreateFileAttribute from .gsa_create_float_functional_attribute import GsaCreateFloatFunctionalAttribute @@ -283,47 +201,31 @@ from .gsa_create_parameter import GsaCreateParameter from .gsa_create_parameter_content import GsaCreateParameterContent from .gsa_create_parameter_value import GsaCreateParameterValue -from .gsa_create_permission import GsaCreatePermission -from .gsa_create_permission_category import GsaCreatePermissionCategory from .gsa_create_picture_attribute import GsaCreatePictureAttribute from .gsa_create_point_attribute import GsaCreatePointAttribute from .gsa_create_profile import GsaCreateProfile from .gsa_create_profile_table import GsaCreateProfileTable -from .gsa_create_put_layout_item import GsaCreatePutLayoutItem -from .gsa_create_put_permission import GsaCreatePutPermission -from .gsa_create_put_permission_category import GsaCreatePutPermissionCategory from .gsa_create_range_attribute import GsaCreateRangeAttribute from .gsa_create_record_history import GsaCreateRecordHistory from .gsa_create_record_link_group import GsaCreateRecordLinkGroup from .gsa_create_record_list import GsaCreateRecordList from .gsa_create_record_list_items_info import GsaCreateRecordListItemsInfo from .gsa_create_replacement_string import GsaCreateReplacementString +from .gsa_create_search_request import GsaCreateSearchRequest from .gsa_create_short_text_attribute import GsaCreateShortTextAttribute -from .gsa_create_smart_link_target import GsaCreateSmartLinkTarget -from .gsa_create_smart_record_link_group import GsaCreateSmartRecordLinkGroup from .gsa_create_standard_name import GsaCreateStandardName -from .gsa_create_static_link_target import GsaCreateStaticLinkTarget from .gsa_create_static_record_link_group import GsaCreateStaticRecordLinkGroup from .gsa_create_subset import GsaCreateSubset from .gsa_create_table import GsaCreateTable from .gsa_create_tabular_attribute import GsaCreateTabularAttribute from .gsa_create_tabular_column import GsaCreateTabularColumn from .gsa_create_unit import GsaCreateUnit -from .gsa_create_unit_mapping import GsaCreateUnitMapping from .gsa_create_unit_system import GsaCreateUnitSystem from .gsa_created_by_user_property import GsaCreatedByUserProperty from .gsa_created_date_property import GsaCreatedDateProperty from .gsa_criterion import GsaCriterion from .gsa_criterion_type import GsaCriterionType -from .gsa_cross_database_link import GsaCrossDatabaseLink -from .gsa_cross_database_link_create_put_layout_item import GsaCrossDatabaseLinkCreatePutLayoutItem -from .gsa_cross_database_record_link import GsaCrossDatabaseRecordLink from .gsa_cross_database_record_link_group import GsaCrossDatabaseRecordLinkGroup -from .gsa_cross_database_record_link_result import GsaCrossDatabaseRecordLinkResult -from .gsa_currencies_info import GsaCurrenciesInfo -from .gsa_currency import GsaCurrency -from .gsa_currency_error_detail import GsaCurrencyErrorDetail -from .gsa_currency_error_reason import GsaCurrencyErrorReason from .gsa_current_user import GsaCurrentUser from .gsa_data_export_applicable_datum import GsaDataExportApplicableDatum from .gsa_data_export_binary_data import GsaDataExportBinaryData @@ -375,27 +277,11 @@ from .gsa_data_modification_error_reason import GsaDataModificationErrorReason from .gsa_data_rule import GsaDataRule from .gsa_data_rules_info import GsaDataRulesInfo -from .gsa_data_source import GsaDataSource -from .gsa_data_update import GsaDataUpdate -from .gsa_data_update_header import GsaDataUpdateHeader -from .gsa_data_update_run_info import GsaDataUpdateRunInfo -from .gsa_data_update_token import GsaDataUpdateToken -from .gsa_data_updater_job import GsaDataUpdaterJob -from .gsa_data_updater_job_status import GsaDataUpdaterJobStatus -from .gsa_data_updater_job_type import GsaDataUpdaterJobType -from .gsa_data_updater_project import GsaDataUpdaterProject from .gsa_data_usage_data_modification_error_detail import GsaDataUsageDataModificationErrorDetail from .gsa_database import GsaDatabase -from .gsa_database_currency_unit_usage_data_modification_error_detail import ( - GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail, -) -from .gsa_database_issues import GsaDatabaseIssues from .gsa_database_key_property import GsaDatabaseKeyProperty -from .gsa_database_security_groups import GsaDatabaseSecurityGroups -from .gsa_database_security_groups_info import GsaDatabaseSecurityGroupsInfo from .gsa_database_status import GsaDatabaseStatus from .gsa_database_status_information import GsaDatabaseStatusInformation -from .gsa_database_user_capabilities import GsaDatabaseUserCapabilities from .gsa_databases_info import GsaDatabasesInfo from .gsa_date_time_aggregation import GsaDateTimeAggregation from .gsa_date_time_aggregation_datum_criterion import GsaDateTimeAggregationDatumCriterion @@ -431,32 +317,15 @@ from .gsa_default_expression_not_found_maths_functional_error_detail import ( GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail, ) -from .gsa_default_fallback_security_groups import GsaDefaultFallbackSecurityGroups from .gsa_default_free_parameter_not_found_maths_functional_error_detail import ( GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail, ) -from .gsa_default_layout_guid_error_detail import GsaDefaultLayoutGuidErrorDetail -from .gsa_default_parameter_value_guid_parameter_error_detail import ( - GsaDefaultParameterValueGuidParameterErrorDetail, -) -from .gsa_default_parameter_value_index_and_guid_parameter_error_detail import ( - GsaDefaultParameterValueIndexAndGuidParameterErrorDetail, -) -from .gsa_default_parameter_value_index_parameter_error_detail import ( - GsaDefaultParameterValueIndexParameterErrorDetail, -) -from .gsa_default_parameter_value_index_without_values_parameter_error_detail import ( - GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail, -) from .gsa_default_parameter_value_usage_data_modification_error_detail import ( GsaDefaultParameterValueUsageDataModificationErrorDetail, ) -from .gsa_default_subset_guid_error_detail import GsaDefaultSubsetGuidErrorDetail from .gsa_delete_record_list_item import GsaDeleteRecordListItem from .gsa_delete_record_list_items import GsaDeleteRecordListItems -from .gsa_description_length_file_error_detail import GsaDescriptionLengthFileErrorDetail from .gsa_discrete_attribute import GsaDiscreteAttribute -from .gsa_discrete_chart_data import GsaDiscreteChartData from .gsa_discrete_datum import GsaDiscreteDatum from .gsa_discrete_datum_exists_criterion import GsaDiscreteDatumExistsCriterion from .gsa_discrete_functional_attribute import GsaDiscreteFunctionalAttribute @@ -491,7 +360,6 @@ from .gsa_discrete_parameter_name_constraint import GsaDiscreteParameterNameConstraint from .gsa_discrete_parameter_value import GsaDiscreteParameterValue from .gsa_discrete_parameter_value_constraint import GsaDiscreteParameterValueConstraint -from .gsa_discrete_quality_system import GsaDiscreteQualitySystem from .gsa_discrete_range import GsaDiscreteRange from .gsa_discrete_range_datum_criterion import GsaDiscreteRangeDatumCriterion from .gsa_discrete_series import GsaDiscreteSeries @@ -505,14 +373,10 @@ from .gsa_discrete_type import GsaDiscreteType from .gsa_discrete_type_deletion_exception import GsaDiscreteTypeDeletionException from .gsa_discrete_type_usage import GsaDiscreteTypeUsage -from .gsa_discrete_type_usage_type import GsaDiscreteTypeUsageType from .gsa_discrete_types_info import GsaDiscreteTypesInfo from .gsa_discrete_value import GsaDiscreteValue from .gsa_discrete_value_aggregate_error_reason import GsaDiscreteValueAggregateErrorReason from .gsa_discrete_value_aggregate_exception import GsaDiscreteValueAggregateException -from .gsa_discrete_value_not_in_discrete_type_error_detail import ( - GsaDiscreteValueNotInDiscreteTypeErrorDetail, -) from .gsa_discrete_values_create_discrete_value import GsaDiscreteValuesCreateDiscreteValue from .gsa_discrete_values_discrete_value import GsaDiscreteValuesDiscreteValue from .gsa_discrete_values_discrete_values_info import GsaDiscreteValuesDiscreteValuesInfo @@ -521,30 +385,10 @@ ) from .gsa_discrete_values_update_discrete_value import GsaDiscreteValuesUpdateDiscreteValue from .gsa_disk_status import GsaDiskStatus -from .gsa_display_name_empty_error_detail import GsaDisplayNameEmptyErrorDetail -from .gsa_display_name_language_not_provided_error_detail import ( - GsaDisplayNameLanguageNotProvidedErrorDetail, -) -from .gsa_display_name_language_not_supported_error_detail import ( - GsaDisplayNameLanguageNotSupportedErrorDetail, -) -from .gsa_display_names_import_error_detail import GsaDisplayNamesImportErrorDetail -from .gsa_display_names_import_error_reason import GsaDisplayNamesImportErrorReason -from .gsa_display_names_import_exception import GsaDisplayNamesImportException -from .gsa_display_names_info import GsaDisplayNamesInfo -from .gsa_divide_by_zero_unit_equation_error_detail import GsaDivideByZeroUnitEquationErrorDetail from .gsa_double_sorting_value import GsaDoubleSortingValue -from .gsa_duplicate_categories_replace_permission_category_error_detail import ( - GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail, -) -from .gsa_duplicate_category_guids_access_control_error_detail import ( - GsaDuplicateCategoryGuidsAccessControlErrorDetail, -) -from .gsa_duplicate_code_currency_error_detail import GsaDuplicateCodeCurrencyErrorDetail from .gsa_duplicate_database_add_database_validation_issue import ( GsaDuplicateDatabaseAddDatabaseValidationIssue, ) -from .gsa_duplicate_discrete_value_error_detail import GsaDuplicateDiscreteValueErrorDetail from .gsa_duplicate_expression_guids_maths_functional_error_detail import ( GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail, ) @@ -554,30 +398,9 @@ from .gsa_duplicate_key_add_database_validation_issue import ( GsaDuplicateKeyAddDatabaseValidationIssue, ) -from .gsa_duplicate_mapped_attribute_guids_error_detail import ( - GsaDuplicateMappedAttributeGuidsErrorDetail, -) -from .gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail import ( - GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .gsa_duplicate_mapped_parameter_guids_error_detail import ( - GsaDuplicateMappedParameterGuidsErrorDetail, -) -from .gsa_duplicate_mapped_record_link_group_guids_error_detail import ( - GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail, -) -from .gsa_duplicate_name_currency_error_detail import GsaDuplicateNameCurrencyErrorDetail from .gsa_duplicate_parameter_guids_attribute_error_detail import ( GsaDuplicateParameterGuidsAttributeErrorDetail, ) -from .gsa_duplicate_permission_guids_access_control_error_detail import ( - GsaDuplicatePermissionGuidsAccessControlErrorDetail, -) -from .gsa_duplicate_permissions_permission_category_error_detail import ( - GsaDuplicatePermissionsPermissionCategoryErrorDetail, -) -from .gsa_duplicate_symbol_unit_error_detail import GsaDuplicateSymbolUnitErrorDetail -from .gsa_duplicate_table_error_detail import GsaDuplicateTableErrorDetail from .gsa_duplicate_tabular_column_guids_error_detail import ( GsaDuplicateTabularColumnGuidsErrorDetail, ) @@ -587,20 +410,17 @@ from .gsa_duplicate_version_guid_add_database_validation_issue import ( GsaDuplicateVersionGuidAddDatabaseValidationIssue, ) +from .gsa_dynamic_link_group_usage_data_modification_error_detail import ( + GsaDynamicLinkGroupUsageDataModificationErrorDetail, +) +from .gsa_dynamic_record_link_group import GsaDynamicRecordLinkGroup from .gsa_empty_axis_name_attribute_error_detail import GsaEmptyAxisNameAttributeErrorDetail -from .gsa_empty_symbol_unit_error_detail import GsaEmptySymbolUnitErrorDetail -from .gsa_empty_table_type_error_detail import GsaEmptyTableTypeErrorDetail from .gsa_enabled_licenses_info import GsaEnabledLicensesInfo from .gsa_entity_already_exists_error_detail import GsaEntityAlreadyExistsErrorDetail from .gsa_entity_identifier_already_specified_error_detail import ( GsaEntityIdentifierAlreadySpecifiedErrorDetail, ) -from .gsa_entity_type import GsaEntityType -from .gsa_equation_unit_error_detail import GsaEquationUnitErrorDetail -from .gsa_error_code import GsaErrorCode from .gsa_error_detail import GsaErrorDetail -from .gsa_error_response import GsaErrorResponse -from .gsa_exception_information import GsaExceptionInformation from .gsa_exclude_values_specifier import GsaExcludeValuesSpecifier from .gsa_existing_tabular_column_guid_error_detail import GsaExistingTabularColumnGuidErrorDetail from .gsa_export_failure import GsaExportFailure @@ -615,28 +435,14 @@ GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail, ) from .gsa_expressions_info import GsaExpressionsInfo -from .gsa_file_already_exists_file_move_error_detail import GsaFileAlreadyExistsFileMoveErrorDetail from .gsa_file_attribute import GsaFileAttribute -from .gsa_file_creation_exception import GsaFileCreationException from .gsa_file_datum import GsaFileDatum from .gsa_file_datum_criterion import GsaFileDatumCriterion from .gsa_file_datum_exists_criterion import GsaFileDatumExistsCriterion -from .gsa_file_error_detail import GsaFileErrorDetail -from .gsa_file_error_reason import GsaFileErrorReason from .gsa_file_header import GsaFileHeader -from .gsa_file_header_info import GsaFileHeaderInfo -from .gsa_file_move_error_detail import GsaFileMoveErrorDetail -from .gsa_file_move_error_reason import GsaFileMoveErrorReason -from .gsa_file_move_exception import GsaFileMoveException -from .gsa_file_name_file_error_detail import GsaFileNameFileErrorDetail -from .gsa_file_name_folder_error_detail import GsaFileNameFolderErrorDetail from .gsa_file_prefix_datum_criterion import GsaFilePrefixDatumCriterion -from .gsa_file_update_exception import GsaFileUpdateException from .gsa_files_info import GsaFilesInfo -from .gsa_find_similar_request import GsaFindSimilarRequest -from .gsa_find_similar_response import GsaFindSimilarResponse -from .gsa_find_similar_result import GsaFindSimilarResult -from .gsa_find_similar_search_criterion import GsaFindSimilarSearchCriterion +from .gsa_find_search_request import GsaFindSearchRequest from .gsa_find_standard_names import GsaFindStandardNames from .gsa_float_functional_aggregation import GsaFloatFunctionalAggregation from .gsa_float_functional_aggregation_datum_criterion import ( @@ -664,24 +470,7 @@ from .gsa_float_series_graph import GsaFloatSeriesGraph from .gsa_float_series_point import GsaFloatSeriesPoint from .gsa_folder import GsaFolder -from .gsa_folder_already_exists_folder_move_error_detail import ( - GsaFolderAlreadyExistsFolderMoveErrorDetail, -) -from .gsa_folder_creation_exception import GsaFolderCreationException -from .gsa_folder_deletion_error_detail import GsaFolderDeletionErrorDetail -from .gsa_folder_deletion_error_reason import GsaFolderDeletionErrorReason -from .gsa_folder_deletion_exception import GsaFolderDeletionException -from .gsa_folder_error_detail import GsaFolderErrorDetail -from .gsa_folder_error_reason import GsaFolderErrorReason -from .gsa_folder_move_error_detail import GsaFolderMoveErrorDetail -from .gsa_folder_move_error_reason import GsaFolderMoveErrorReason -from .gsa_folder_move_exception import GsaFolderMoveException -from .gsa_folder_type import GsaFolderType -from .gsa_folder_update_exception import GsaFolderUpdateException from .gsa_folders_info import GsaFoldersInfo -from .gsa_forbid_orphans_record_link_group_error_detail import ( - GsaForbidOrphansRecordLinkGroupErrorDetail, -) from .gsa_free_text_aggregation import GsaFreeTextAggregation from .gsa_free_text_aggregation_criterion import GsaFreeTextAggregationCriterion from .gsa_free_text_criterion import GsaFreeTextCriterion @@ -689,13 +478,9 @@ from .gsa_full_layout_section import GsaFullLayoutSection from .gsa_full_name_property import GsaFullNameProperty from .gsa_func_no_params_attribute_error_detail import GsaFuncNoParamsAttributeErrorDetail -from .gsa_functional_data_default_usage_data_modification_error_detail import ( - GsaFunctionalDataDefaultUsageDataModificationErrorDetail, -) from .gsa_functional_datum_parameter_info import GsaFunctionalDatumParameterInfo from .gsa_functional_parameter_setting import GsaFunctionalParameterSetting from .gsa_functional_type import GsaFunctionalType -from .gsa_general_unit_equation_error_detail import GsaGeneralUnitEquationErrorDetail from .gsa_generated_integration_schema_of_object_identifier import ( GsaGeneratedIntegrationSchemaOfObjectIdentifier, ) @@ -705,7 +490,6 @@ GsaGetModifiableRecordVersionControlException, ) from .gsa_get_unit_conversions_request import GsaGetUnitConversionsRequest -from .gsa_get_unit_equivalents_exception import GsaGetUnitEquivalentsException from .gsa_graph import GsaGraph from .gsa_graph_decoration_type import GsaGraphDecorationType from .gsa_graph_evaluation_settings import GsaGraphEvaluationSettings @@ -714,7 +498,6 @@ from .gsa_graph_type import GsaGraphType from .gsa_graph_value import GsaGraphValue from .gsa_graph_value_type import GsaGraphValueType -from .gsa_grid import GsaGrid from .gsa_grid_graph import GsaGridGraph from .gsa_guid_only_attribute import GsaGuidOnlyAttribute from .gsa_guid_only_discrete_type import GsaGuidOnlyDiscreteType @@ -725,7 +508,6 @@ from .gsa_guid_only_layout import GsaGuidOnlyLayout from .gsa_guid_only_mapping_of_object_identifier import GsaGuidOnlyMappingOfObjectIdentifier from .gsa_guid_only_source_of_object_identifier import GsaGuidOnlySourceOfObjectIdentifier -from .gsa_help_paths_validation_response import GsaHelpPathsValidationResponse from .gsa_histogram import GsaHistogram from .gsa_histogram_bucket import GsaHistogramBucket from .gsa_hyperlink_attribute import GsaHyperlinkAttribute @@ -734,17 +516,12 @@ from .gsa_hyperlink_datum_exists_criterion import GsaHyperlinkDatumExistsCriterion from .gsa_hyperlink_prefix_datum_criterion import GsaHyperlinkPrefixDatumCriterion from .gsa_hyperlink_target import GsaHyperlinkTarget -from .gsa_in_use_parameter_value_error_detail import GsaInUseParameterValueErrorDetail -from .gsa_inclusiveness import GsaInclusiveness -from .gsa_incompatible_units_error_detail import GsaIncompatibleUnitsErrorDetail from .gsa_index_record_failure import GsaIndexRecordFailure from .gsa_indirect_links import GsaIndirectLinks -from .gsa_input_connection_details import GsaInputConnectionDetails from .gsa_input_validation_error_detail import GsaInputValidationErrorDetail from .gsa_integer_aggregation import GsaIntegerAggregation from .gsa_integer_aggregation_datum_criterion import GsaIntegerAggregationDatumCriterion from .gsa_integer_attribute import GsaIntegerAttribute -from .gsa_integer_chart_data import GsaIntegerChartData from .gsa_integer_datum import GsaIntegerDatum from .gsa_integer_datum_criterion import GsaIntegerDatumCriterion from .gsa_integer_datum_exists_criterion import GsaIntegerDatumExistsCriterion @@ -765,10 +542,6 @@ ) from .gsa_integration_schema_of_object_identifier import GsaIntegrationSchemaOfObjectIdentifier from .gsa_integration_schema_status import GsaIntegrationSchemaStatus -from .gsa_invalid_equivalence_target_error_detail import GsaInvalidEquivalenceTargetErrorDetail -from .gsa_invalid_exchange_rate_currency_error_detail import ( - GsaInvalidExchangeRateCurrencyErrorDetail, -) from .gsa_invalid_key_add_database_validation_issue import GsaInvalidKeyAddDatabaseValidationIssue from .gsa_invalid_parent_state_error_detail import GsaInvalidParentStateErrorDetail from .gsa_invalid_version_state_error_detail import GsaInvalidVersionStateErrorDetail @@ -788,7 +561,6 @@ from .gsa_layout_sections_info import GsaLayoutSectionsInfo from .gsa_layout_tabular_column import GsaLayoutTabularColumn from .gsa_layouts_info import GsaLayoutsInfo -from .gsa_link import GsaLink from .gsa_link_aggregation import GsaLinkAggregation from .gsa_link_aggregation_datum_criterion import GsaLinkAggregationDatumCriterion from .gsa_link_attribute_to_export import GsaLinkAttributeToExport @@ -841,13 +613,9 @@ from .gsa_local_range_tabular_column import GsaLocalRangeTabularColumn from .gsa_local_rows_behavior import GsaLocalRowsBehavior from .gsa_local_short_text_tabular_column import GsaLocalShortTextTabularColumn -from .gsa_log_scale_negative_parameter_value_error_detail import ( - GsaLogScaleNegativeParameterValueErrorDetail, -) from .gsa_logical_aggregation import GsaLogicalAggregation from .gsa_logical_aggregation_datum_criterion import GsaLogicalAggregationDatumCriterion from .gsa_logical_attribute import GsaLogicalAttribute -from .gsa_logical_chart_data import GsaLogicalChartData from .gsa_logical_datum import GsaLogicalDatum from .gsa_logical_datum_criterion import GsaLogicalDatumCriterion from .gsa_logical_datum_exists_criterion import GsaLogicalDatumExistsCriterion @@ -857,11 +625,7 @@ from .gsa_long_text_datum_criterion import GsaLongTextDatumCriterion from .gsa_long_text_datum_exists_criterion import GsaLongTextDatumExistsCriterion from .gsa_long_text_prefix_datum_criterion import GsaLongTextPrefixDatumCriterion -from .gsa_many_to_many_forbid_orphans_record_link_group_error_detail import ( - GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail, -) from .gsa_mapping_of_object_identifier import GsaMappingOfObjectIdentifier -from .gsa_match_mode import GsaMatchMode from .gsa_maths_content import GsaMathsContent from .gsa_maths_functional_attribute import GsaMathsFunctionalAttribute from .gsa_maths_functional_attribute_error_detail import GsaMathsFunctionalAttributeErrorDetail @@ -869,12 +633,6 @@ from .gsa_maths_functional_datum_exists_criterion import GsaMathsFunctionalDatumExistsCriterion from .gsa_maths_functional_error_detail import GsaMathsFunctionalErrorDetail from .gsa_maths_functional_error_reason import GsaMathsFunctionalErrorReason -from .gsa_max_permissions_reached_permission_error_detail import ( - GsaMaxPermissionsReachedPermissionErrorDetail, -) -from .gsa_meta_attribute_cannot_have_meta_attribute_error_detail import ( - GsaMetaAttributeCannotHaveMetaAttributeErrorDetail, -) from .gsa_mfa_expression_error_detail import GsaMfaExpressionErrorDetail from .gsa_mfa_expression_error_reason import GsaMfaExpressionErrorReason from .gsa_mi_version import GsaMiVersion @@ -887,44 +645,12 @@ from .gsa_move_file import GsaMoveFile from .gsa_move_folder import GsaMoveFolder from .gsa_move_record_history import GsaMoveRecordHistory -from .gsa_multi_valued_point_data_usage_data_modification_error_detail import ( - GsaMultiValuedPointDataUsageDataModificationErrorDetail, -) -from .gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail import ( - GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail, -) -from .gsa_name_already_exists_as_reverse_record_link_group_error_detail import ( - GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail, -) from .gsa_name_already_exists_error_detail import GsaNameAlreadyExistsErrorDetail -from .gsa_name_already_specified_error_detail import GsaNameAlreadySpecifiedErrorDetail -from .gsa_name_missing_currency_error_detail import GsaNameMissingCurrencyErrorDetail from .gsa_name_not_provided_error_detail import GsaNameNotProvidedErrorDetail -from .gsa_name_same_as_reverse_name_record_link_group_error_detail import ( - GsaNameSameAsReverseNameRecordLinkGroupErrorDetail, -) -from .gsa_name_whitespace_currency_error_detail import GsaNameWhitespaceCurrencyErrorDetail -from .gsa_name_whitespace_parameter_value_error_detail import ( - GsaNameWhitespaceParameterValueErrorDetail, -) from .gsa_named_criterion import GsaNamedCriterion -from .gsa_named_entity_access_control_category_error_detail import ( - GsaNamedEntityAccessControlCategoryErrorDetail, -) from .gsa_named_entity_attribute_error_detail import GsaNamedEntityAttributeErrorDetail -from .gsa_named_entity_constant_error_detail import GsaNamedEntityConstantErrorDetail from .gsa_named_entity_error_detail import GsaNamedEntityErrorDetail from .gsa_named_entity_error_reason import GsaNamedEntityErrorReason -from .gsa_named_entity_file_error_detail import GsaNamedEntityFileErrorDetail -from .gsa_named_entity_folder_error_detail import GsaNamedEntityFolderErrorDetail -from .gsa_named_entity_parameter_error_detail import GsaNamedEntityParameterErrorDetail -from .gsa_named_entity_parameter_value_error_detail import GsaNamedEntityParameterValueErrorDetail -from .gsa_named_entity_permission_error_detail import GsaNamedEntityPermissionErrorDetail -from .gsa_named_entity_record_link_group_error_detail import ( - GsaNamedEntityRecordLinkGroupErrorDetail, -) -from .gsa_named_entity_table_error_detail import GsaNamedEntityTableErrorDetail -from .gsa_named_entity_unit_error_detail import GsaNamedEntityUnitErrorDetail from .gsa_new_layout_association_chain_item import GsaNewLayoutAssociationChainItem from .gsa_new_layout_association_chain_link import GsaNewLayoutAssociationChainLink from .gsa_new_layout_attribute_item import GsaNewLayoutAttributeItem @@ -933,77 +659,29 @@ from .gsa_new_layout_item_type import GsaNewLayoutItemType from .gsa_new_layout_record_link_item import GsaNewLayoutRecordLinkItem from .gsa_new_layout_smart_link_item import GsaNewLayoutSmartLinkItem -from .gsa_no_attribute_pairs_smart_attributes_error_detail import ( - GsaNoAttributePairsSmartAttributesErrorDetail, -) -from .gsa_no_data_file_error_detail import GsaNoDataFileErrorDetail from .gsa_no_expressions_maths_functional_error_detail import ( GsaNoExpressionsMathsFunctionalErrorDetail, ) -from .gsa_no_file_file_error_detail import GsaNoFileFileErrorDetail -from .gsa_no_parameter_values_parameter_error_detail import GsaNoParameterValuesParameterErrorDetail -from .gsa_no_permissions_permission_category_error_detail import ( - GsaNoPermissionsPermissionCategoryErrorDetail, -) -from .gsa_no_such_attribute_smart_attributes_error_detail import ( - GsaNoSuchAttributeSmartAttributesErrorDetail, -) -from .gsa_no_such_categories_replace_permission_category_error_detail import ( - GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail, -) -from .gsa_no_such_category_access_control_error_detail import ( - GsaNoSuchCategoryAccessControlErrorDetail, -) -from .gsa_no_such_entity_access_control_category_error_detail import ( - GsaNoSuchEntityAccessControlCategoryErrorDetail, -) from .gsa_no_such_entity_attribute_error_detail import GsaNoSuchEntityAttributeErrorDetail from .gsa_no_such_entity_tabular_column_error_detail import GsaNoSuchEntityTabularColumnErrorDetail from .gsa_no_such_expressions_maths_functional_error_detail import ( GsaNoSuchExpressionsMathsFunctionalErrorDetail, ) -from .gsa_no_such_new_parent_file_move_error_detail import GsaNoSuchNewParentFileMoveErrorDetail -from .gsa_no_such_new_parent_folder_move_error_detail import GsaNoSuchNewParentFolderMoveErrorDetail from .gsa_no_such_parameter_value_parameter_content_error_detail import ( GsaNoSuchParameterValueParameterContentErrorDetail, ) -from .gsa_no_such_permission_access_control_error_detail import ( - GsaNoSuchPermissionAccessControlErrorDetail, -) -from .gsa_no_such_permissions_permission_category_error_detail import ( - GsaNoSuchPermissionsPermissionCategoryErrorDetail, -) -from .gsa_no_such_target_table_record_link_group_error_detail import ( - GsaNoSuchTargetTableRecordLinkGroupErrorDetail, -) -from .gsa_no_such_unit_constant_error_detail import GsaNoSuchUnitConstantErrorDetail -from .gsa_no_such_unit_parameter_error_detail import GsaNoSuchUnitParameterErrorDetail -from .gsa_no_such_unit_system_unit_equivalent_error_detail import ( - GsaNoSuchUnitSystemUnitEquivalentErrorDetail, -) -from .gsa_no_such_unit_unit_equivalent_error_detail import GsaNoSuchUnitUnitEquivalentErrorDetail from .gsa_no_value_exists_graph_value import GsaNoValueExistsGraphValue from .gsa_no_values_specifier import GsaNoValuesSpecifier -from .gsa_non_custom_standard_name_cannot_be_changed_error_detail import ( - GsaNonCustomStandardNameCannotBeChangedErrorDetail, -) from .gsa_not_applicable_datum import GsaNotApplicableDatum from .gsa_not_the_latest_version_error_detail import GsaNotTheLatestVersionErrorDetail from .gsa_not_versioned_error_detail import GsaNotVersionedErrorDetail -from .gsa_number_parsing_unit_equation_error_detail import GsaNumberParsingUnitEquationErrorDetail from .gsa_numeric_graph_parameter_value import GsaNumericGraphParameterValue from .gsa_numeric_parameter import GsaNumericParameter from .gsa_numeric_parameter_constraint import GsaNumericParameterConstraint from .gsa_numeric_parameter_content import GsaNumericParameterContent from .gsa_numeric_parameter_data_value import GsaNumericParameterDataValue from .gsa_numeric_parameter_value import GsaNumericParameterValue -from .gsa_numeric_restricted_interpolation_parameter_error_detail import ( - GsaNumericRestrictedInterpolationParameterErrorDetail, -) from .gsa_object_identifier import GsaObjectIdentifier -from .gsa_paginated_item_type import GsaPaginatedItemType -from .gsa_paginated_response_of import GsaPaginatedResponseOf -from .gsa_pagination_links import GsaPaginationLinks from .gsa_paging_options import GsaPagingOptions from .gsa_parameter import GsaParameter from .gsa_parameter_constraint import GsaParameterConstraint @@ -1021,11 +699,8 @@ from .gsa_parameter_content_unknown_parameters_maths_functional_error_detail import ( GsaParameterContentUnknownParametersMathsFunctionalErrorDetail, ) -from .gsa_parameter_creation_exception import GsaParameterCreationException from .gsa_parameter_data_value import GsaParameterDataValue from .gsa_parameter_deletion_exception import GsaParameterDeletionException -from .gsa_parameter_error_detail import GsaParameterErrorDetail -from .gsa_parameter_error_reason import GsaParameterErrorReason from .gsa_parameter_info import GsaParameterInfo from .gsa_parameter_info_interpolation_type import GsaParameterInfoInterpolationType from .gsa_parameter_info_parameter_type import GsaParameterInfoParameterType @@ -1037,56 +712,14 @@ from .gsa_parameter_type_parameter_content_error_detail import ( GsaParameterTypeParameterContentErrorDetail, ) -from .gsa_parameter_type_parameter_error_detail import GsaParameterTypeParameterErrorDetail -from .gsa_parameter_update_exception import GsaParameterUpdateException -from .gsa_parameter_usage_data_modification_error_detail import ( - GsaParameterUsageDataModificationErrorDetail, -) from .gsa_parameter_value import GsaParameterValue -from .gsa_parameter_value_creation_exception import GsaParameterValueCreationException from .gsa_parameter_value_deletion_exception import GsaParameterValueDeletionException -from .gsa_parameter_value_error_detail import GsaParameterValueErrorDetail -from .gsa_parameter_value_error_reason import GsaParameterValueErrorReason -from .gsa_parameter_value_parameter_error_detail import GsaParameterValueParameterErrorDetail from .gsa_parameter_value_type import GsaParameterValueType -from .gsa_parameter_value_type_parameter_value_error_detail import ( - GsaParameterValueTypeParameterValueErrorDetail, -) -from .gsa_parameter_value_update_exception import GsaParameterValueUpdateException -from .gsa_parameter_value_used_by_type import GsaParameterValueUsedByType from .gsa_parameter_with_data_value import GsaParameterWithDataValue from .gsa_parameters_info import GsaParametersInfo from .gsa_permission import GsaPermission -from .gsa_permission_access_control import GsaPermissionAccessControl -from .gsa_permission_based_access_control_info import GsaPermissionBasedAccessControlInfo -from .gsa_permission_categories_access_control_error_detail import ( - GsaPermissionCategoriesAccessControlErrorDetail, -) -from .gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) -from .gsa_permission_categories_access_control_update_exception import ( - GsaPermissionCategoriesAccessControlUpdateException, -) from .gsa_permission_categories_info import GsaPermissionCategoriesInfo from .gsa_permission_category import GsaPermissionCategory -from .gsa_permission_category_access_control import GsaPermissionCategoryAccessControl -from .gsa_permission_category_access_control_info import GsaPermissionCategoryAccessControlInfo -from .gsa_permission_category_creation_exception import GsaPermissionCategoryCreationException -from .gsa_permission_category_error_detail import GsaPermissionCategoryErrorDetail -from .gsa_permission_category_error_reason import GsaPermissionCategoryErrorReason -from .gsa_permission_category_replace_exception import GsaPermissionCategoryReplaceException -from .gsa_permission_category_update_exception import GsaPermissionCategoryUpdateException -from .gsa_permission_creation_exception import GsaPermissionCreationException -from .gsa_permission_deletion_error_detail import GsaPermissionDeletionErrorDetail -from .gsa_permission_deletion_error_reason import GsaPermissionDeletionErrorReason -from .gsa_permission_deletion_exception import GsaPermissionDeletionException -from .gsa_permission_error_detail import GsaPermissionErrorDetail -from .gsa_permission_error_reason import GsaPermissionErrorReason -from .gsa_permission_permission_category_error_detail import ( - GsaPermissionPermissionCategoryErrorDetail, -) -from .gsa_permission_update_exception import GsaPermissionUpdateException from .gsa_permissions_info import GsaPermissionsInfo from .gsa_picture_attribute import GsaPictureAttribute from .gsa_picture_datum import GsaPictureDatum @@ -1095,7 +728,6 @@ from .gsa_point_aggregation import GsaPointAggregation from .gsa_point_aggregation_datum_criterion import GsaPointAggregationDatumCriterion from .gsa_point_attribute import GsaPointAttribute -from .gsa_point_chart_data import GsaPointChartData from .gsa_point_data_value import GsaPointDataValue from .gsa_point_datum import GsaPointDatum from .gsa_point_datum_criterion import GsaPointDatumCriterion @@ -1115,15 +747,6 @@ from .gsa_profile_table import GsaProfileTable from .gsa_profile_tables_info import GsaProfileTablesInfo from .gsa_property import GsaProperty -from .gsa_put_layout_item import GsaPutLayoutItem -from .gsa_put_permission import GsaPutPermission -from .gsa_put_permission_category import GsaPutPermissionCategory -from .gsa_put_type import GsaPutType -from .gsa_quality_discrete_value import GsaQualityDiscreteValue -from .gsa_quality_system import GsaQualitySystem -from .gsa_quality_system_guid_error_detail import GsaQualitySystemGuidErrorDetail -from .gsa_quality_system_type import GsaQualitySystemType -from .gsa_quality_systems_info import GsaQualitySystemsInfo from .gsa_query_attribute import GsaQueryAttribute from .gsa_query_attribute_filter import GsaQueryAttributeFilter from .gsa_query_attribute_info import GsaQueryAttributeInfo @@ -1140,25 +763,9 @@ from .gsa_query_discrete_type_properties import GsaQueryDiscreteTypeProperties from .gsa_query_discrete_types_info import GsaQueryDiscreteTypesInfo from .gsa_query_discrete_types_request import GsaQueryDiscreteTypesRequest -from .gsa_query_layout import GsaQueryLayout -from .gsa_query_layout_filter import GsaQueryLayoutFilter -from .gsa_query_layout_item import GsaQueryLayoutItem -from .gsa_query_layout_item_filter import GsaQueryLayoutItemFilter -from .gsa_query_layout_item_properties import GsaQueryLayoutItemProperties -from .gsa_query_layout_properties import GsaQueryLayoutProperties -from .gsa_query_layout_section import GsaQueryLayoutSection -from .gsa_query_layout_section_filter import GsaQueryLayoutSectionFilter -from .gsa_query_layout_section_properties import GsaQueryLayoutSectionProperties -from .gsa_query_layout_sections_info import GsaQueryLayoutSectionsInfo -from .gsa_query_layout_sections_request import GsaQueryLayoutSectionsRequest -from .gsa_query_layouts_info import GsaQueryLayoutsInfo -from .gsa_query_layouts_request import GsaQueryLayoutsRequest from .gsa_query_slim_discrete_type import GsaQuerySlimDiscreteType from .gsa_query_slim_discrete_type_properties import GsaQuerySlimDiscreteTypeProperties -from .gsa_query_slim_entity import GsaQuerySlimEntity -from .gsa_query_slim_entity_properties import GsaQuerySlimEntityProperties from .gsa_query_slim_named_entity import GsaQuerySlimNamedEntity -from .gsa_query_slim_named_entity_filter import GsaQuerySlimNamedEntityFilter from .gsa_query_slim_named_entity_properties import GsaQuerySlimNamedEntityProperties from .gsa_query_slim_typed_attribute import GsaQuerySlimTypedAttribute from .gsa_query_slim_typed_attribute_properties import GsaQuerySlimTypedAttributeProperties @@ -1169,18 +776,14 @@ from .gsa_query_tables_request import GsaQueryTablesRequest from .gsa_query_tabular_attribute_target import GsaQueryTabularAttributeTarget from .gsa_query_tabular_attribute_target_properties import GsaQueryTabularAttributeTargetProperties -from .gsa_query_tabular_column import GsaQueryTabularColumn -from .gsa_query_tabular_column_properties import GsaQueryTabularColumnProperties from .gsa_query_unit import GsaQueryUnit from .gsa_query_unit_properties import GsaQueryUnitProperties from .gsa_range_aggregation import GsaRangeAggregation from .gsa_range_aggregation_datum_criterion import GsaRangeAggregationDatumCriterion from .gsa_range_attribute import GsaRangeAttribute -from .gsa_range_chart_data import GsaRangeChartData from .gsa_range_datum import GsaRangeDatum from .gsa_range_datum_criterion import GsaRangeDatumCriterion from .gsa_range_datum_exists_criterion import GsaRangeDatumExistsCriterion -from .gsa_range_endpoint import GsaRangeEndpoint from .gsa_range_fixed_width_histogram_aggregation_datum_criterion import ( GsaRangeFixedWidthHistogramAggregationDatumCriterion, ) @@ -1191,7 +794,7 @@ ) from .gsa_record_ancestor_criterion import GsaRecordAncestorCriterion from .gsa_record_ancestor_history_criterion import GsaRecordAncestorHistoryCriterion -from .gsa_record_and_attribute_selection_type import GsaRecordAndAttributeSelectionType +from .gsa_record_capabilities import GsaRecordCapabilities from .gsa_record_color import GsaRecordColor from .gsa_record_color_property import GsaRecordColorProperty from .gsa_record_export_failure import GsaRecordExportFailure @@ -1201,18 +804,9 @@ from .gsa_record_history_guid_property import GsaRecordHistoryGuidProperty from .gsa_record_history_move_exception import GsaRecordHistoryMoveException from .gsa_record_history_reference import GsaRecordHistoryReference -from .gsa_record_link import GsaRecordLink -from .gsa_record_link_base import GsaRecordLinkBase -from .gsa_record_link_create_put_layout_item import GsaRecordLinkCreatePutLayoutItem from .gsa_record_link_group import GsaRecordLinkGroup -from .gsa_record_link_group_creation_exception import GsaRecordLinkGroupCreationException -from .gsa_record_link_group_error_detail import GsaRecordLinkGroupErrorDetail -from .gsa_record_link_group_error_reason import GsaRecordLinkGroupErrorReason from .gsa_record_link_group_type import GsaRecordLinkGroupType -from .gsa_record_link_group_update_exception import GsaRecordLinkGroupUpdateException from .gsa_record_link_groups_info import GsaRecordLinkGroupsInfo -from .gsa_record_link_result import GsaRecordLinkResult -from .gsa_record_link_results import GsaRecordLinkResults from .gsa_record_list_header import GsaRecordListHeader from .gsa_record_list_headers_info import GsaRecordListHeadersInfo from .gsa_record_list_items_info import GsaRecordListItemsInfo @@ -1232,61 +826,30 @@ from .gsa_record_reference_type import GsaRecordReferenceType from .gsa_record_subset_criterion import GsaRecordSubsetCriterion from .gsa_record_type import GsaRecordType -from .gsa_record_type_criterion import GsaRecordTypeCriterion from .gsa_record_type_property import GsaRecordTypeProperty -from .gsa_record_user_capabilities import GsaRecordUserCapabilities from .gsa_record_version import GsaRecordVersion from .gsa_record_version_reference import GsaRecordVersionReference from .gsa_record_with_data import GsaRecordWithData from .gsa_referenced_by_type import GsaReferencedByType from .gsa_referential_integrity_model import GsaReferentialIntegrityModel -from .gsa_referential_integrity_model_record_link_group_error_detail import ( - GsaReferentialIntegrityModelRecordLinkGroupErrorDetail, -) -from .gsa_register_update_request import GsaRegisterUpdateRequest from .gsa_release_record_version_control_exception import GsaReleaseRecordVersionControlException from .gsa_release_table_version_control_exception import GsaReleaseTableVersionControlException from .gsa_released_date_property import GsaReleasedDateProperty from .gsa_relevance_sort_criterion import GsaRelevanceSortCriterion from .gsa_remove_record_history_from_subset import GsaRemoveRecordHistoryFromSubset from .gsa_reorder_sections_info import GsaReorderSectionsInfo -from .gsa_replace_permission_categories_request import GsaReplacePermissionCategoriesRequest -from .gsa_replace_permission_category_error_detail import GsaReplacePermissionCategoryErrorDetail -from .gsa_replace_permission_category_error_reason import GsaReplacePermissionCategoryErrorReason from .gsa_replacement_string import GsaReplacementString from .gsa_replacement_strings_info import GsaReplacementStringsInfo -from .gsa_resolve_link_targets_info import GsaResolveLinkTargetsInfo -from .gsa_resolve_link_targets_request import GsaResolveLinkTargetsRequest +from .gsa_resolved_link import GsaResolvedLink +from .gsa_resolved_link_info import GsaResolvedLinkInfo from .gsa_resolved_link_target import GsaResolvedLinkTarget -from .gsa_resolved_target_attribute import GsaResolvedTargetAttribute from .gsa_response_options import GsaResponseOptions from .gsa_resubmit_job_request import GsaResubmitJobRequest -from .gsa_retarget_potential_request import GsaRetargetPotentialRequest -from .gsa_retarget_request import GsaRetargetRequest -from .gsa_retarget_result import GsaRetargetResult -from .gsa_retarget_result_type import GsaRetargetResultType -from .gsa_retarget_results_info import GsaRetargetResultsInfo -from .gsa_reverse_name_already_exists_as_name_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail, -) -from .gsa_reverse_name_already_exists_record_link_group_error_detail import ( - GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail, -) -from .gsa_reverse_name_not_provided_record_link_group_error_detail import ( - GsaReverseNameNotProvidedRecordLinkGroupErrorDetail, -) from .gsa_rich_text_type import GsaRichTextType from .gsa_rich_text_value import GsaRichTextValue -from .gsa_role_not_provided_permission_error_detail import GsaRoleNotProvidedPermissionErrorDetail from .gsa_rollup_export_failure import GsaRollupExportFailure from .gsa_rollup_reference import GsaRollupReference -from .gsa_root_folder_move_error_detail import GsaRootFolderMoveErrorDetail -from .gsa_root_record_not_available_to_rename_error_detail import ( - GsaRootRecordNotAvailableToRenameErrorDetail, -) -from .gsa_rule_engine import GsaRuleEngine -from .gsa_same_parent_file_move_error_detail import GsaSameParentFileMoveErrorDetail -from .gsa_same_parent_folder_move_error_detail import GsaSameParentFolderMoveErrorDetail +from .gsa_save_search_request import GsaSaveSearchRequest from .gsa_schema_too_new_add_database_validation_issue import ( GsaSchemaTooNewAddDatabaseValidationIssue, ) @@ -1294,9 +857,8 @@ GsaSchemaTooOldAddDatabaseValidationIssue, ) from .gsa_search_cluster_status import GsaSearchClusterStatus +from .gsa_search_detail import GsaSearchDetail from .gsa_search_index_status import GsaSearchIndexStatus -from .gsa_search_mask import GsaSearchMask -from .gsa_search_mask_info import GsaSearchMaskInfo from .gsa_search_mask_usage_data_modification_error_detail import ( GsaSearchMaskUsageDataModificationErrorDetail, ) @@ -1304,20 +866,13 @@ from .gsa_search_response import GsaSearchResponse from .gsa_search_result import GsaSearchResult from .gsa_search_results_request import GsaSearchResultsRequest -from .gsa_search_service_status import GsaSearchServiceStatus -from .gsa_search_template import GsaSearchTemplate -from .gsa_search_template_attribute_item import GsaSearchTemplateAttributeItem -from .gsa_search_template_info import GsaSearchTemplateInfo -from .gsa_search_template_item import GsaSearchTemplateItem -from .gsa_search_template_item_type import GsaSearchTemplateItemType -from .gsa_search_template_link_item import GsaSearchTemplateLinkItem -from .gsa_search_template_tabular_column_item import GsaSearchTemplateTabularColumnItem from .gsa_searchable_record_property import GsaSearchableRecordProperty +from .gsa_security_attribute_grouping import GsaSecurityAttributeGrouping from .gsa_security_attribute_usage_data_modification_error_detail import ( GsaSecurityAttributeUsageDataModificationErrorDetail, ) from .gsa_security_groups import GsaSecurityGroups -from .gsa_selection import GsaSelection +from .gsa_selection_search import GsaSelectionSearch from .gsa_series_graph import GsaSeriesGraph from .gsa_set_date_time_datum import GsaSetDateTimeDatum from .gsa_set_datum import GsaSetDatum @@ -1337,9 +892,6 @@ from .gsa_set_short_text_datum import GsaSetShortTextDatum from .gsa_set_tabular_datum import GsaSetTabularDatum from .gsa_set_tabular_datum_row import GsaSetTabularDatumRow -from .gsa_set_unit_equivalent import GsaSetUnitEquivalent -from .gsa_set_unit_equivalents_exception import GsaSetUnitEquivalentsException -from .gsa_set_unit_equivalents_info import GsaSetUnitEquivalentsInfo from .gsa_short_name_property import GsaShortNameProperty from .gsa_short_text_aggregation import GsaShortTextAggregation from .gsa_short_text_aggregation_datum_criterion import GsaShortTextAggregationDatumCriterion @@ -1349,12 +901,10 @@ from .gsa_short_text_datum_exists_criterion import GsaShortTextDatumExistsCriterion from .gsa_short_text_prefix_datum_criterion import GsaShortTextPrefixDatumCriterion from .gsa_significant_figures_info import GsaSignificantFiguresInfo -from .gsa_similarity_setting import GsaSimilaritySetting -from .gsa_similarity_settings import GsaSimilaritySettings from .gsa_simple_attribute_to_export import GsaSimpleAttributeToExport from .gsa_slim_attribute import GsaSlimAttribute -from .gsa_slim_attribute_with_help_path import GsaSlimAttributeWithHelpPath from .gsa_slim_configuration import GsaSlimConfiguration +from .gsa_slim_constant import GsaSlimConstant from .gsa_slim_database import GsaSlimDatabase from .gsa_slim_discrete_type import GsaSlimDiscreteType from .gsa_slim_entity import GsaSlimEntity @@ -1363,88 +913,45 @@ from .gsa_slim_identified_entity import GsaSlimIdentifiedEntity from .gsa_slim_layout import GsaSlimLayout from .gsa_slim_layout_section import GsaSlimLayoutSection -from .gsa_slim_localized_entity import GsaSlimLocalizedEntity from .gsa_slim_named_entity import GsaSlimNamedEntity +from .gsa_slim_named_unit import GsaSlimNamedUnit from .gsa_slim_objects import GsaSlimObjects from .gsa_slim_parameter import GsaSlimParameter -from .gsa_slim_parameter_with_help_path import GsaSlimParameterWithHelpPath +from .gsa_slim_permission import GsaSlimPermission +from .gsa_slim_permission_category import GsaSlimPermissionCategory from .gsa_slim_profile import GsaSlimProfile from .gsa_slim_profile_table import GsaSlimProfileTable from .gsa_slim_record_history import GsaSlimRecordHistory from .gsa_slim_record_link_group import GsaSlimRecordLinkGroup from .gsa_slim_record_version import GsaSlimRecordVersion from .gsa_slim_replacement_string import GsaSlimReplacementString -from .gsa_slim_search_mask import GsaSlimSearchMask -from .gsa_slim_search_template import GsaSlimSearchTemplate from .gsa_slim_subset import GsaSlimSubset from .gsa_slim_table import GsaSlimTable from .gsa_slim_typed_attribute import GsaSlimTypedAttribute from .gsa_slim_unit import GsaSlimUnit -from .gsa_smart_attributes_error_detail import GsaSmartAttributesErrorDetail -from .gsa_smart_attributes_error_reason import GsaSmartAttributesErrorReason -from .gsa_smart_attributes_record_link_group_error_detail import ( - GsaSmartAttributesRecordLinkGroupErrorDetail, -) -from .gsa_smart_link import GsaSmartLink -from .gsa_smart_link_create_put_layout_item import GsaSmartLinkCreatePutLayoutItem -from .gsa_smart_link_group_usage_data_modification_error_detail import ( - GsaSmartLinkGroupUsageDataModificationErrorDetail, -) -from .gsa_smart_record_link_group import GsaSmartRecordLinkGroup -from .gsa_smart_record_link_result import GsaSmartRecordLinkResult +from .gsa_slim_unit_system import GsaSlimUnitSystem +from .gsa_smtp_properties import GsaSmtpProperties from .gsa_sort_criterion import GsaSortCriterion from .gsa_sort_criterion_type import GsaSortCriterionType from .gsa_sort_direction import GsaSortDirection from .gsa_sort_type import GsaSortType from .gsa_sorting_value import GsaSortingValue from .gsa_sorting_value_type import GsaSortingValueType -from .gsa_source_cannot_be_target_smart_attributes_error_detail import ( - GsaSourceCannotBeTargetSmartAttributesErrorDetail, -) from .gsa_source_of_object_identifier import GsaSourceOfObjectIdentifier from .gsa_specific_values_specifier import GsaSpecificValuesSpecifier -from .gsa_sql_credentials import GsaSqlCredentials from .gsa_standard_name import GsaStandardName -from .gsa_standard_name_already_exists_error_detail import GsaStandardNameAlreadyExistsErrorDetail -from .gsa_standard_name_creation_exception import GsaStandardNameCreationException -from .gsa_standard_name_deletion_error_detail import GsaStandardNameDeletionErrorDetail -from .gsa_standard_name_deletion_error_reason import GsaStandardNameDeletionErrorReason -from .gsa_standard_name_deletion_exception import GsaStandardNameDeletionException -from .gsa_standard_name_error_detail import GsaStandardNameErrorDetail -from .gsa_standard_name_error_reason import GsaStandardNameErrorReason -from .gsa_standard_name_update_exception import GsaStandardNameUpdateException from .gsa_standard_names_info import GsaStandardNamesInfo -from .gsa_static_record_link import GsaStaticRecordLink from .gsa_static_record_link_group import GsaStaticRecordLinkGroup -from .gsa_static_record_link_result import GsaStaticRecordLinkResult from .gsa_string_sorting_value import GsaStringSortingValue from .gsa_subset import GsaSubset from .gsa_subsets_info import GsaSubsetsInfo -from .gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail import ( - GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail, -) -from .gsa_symbol_cannot_contain_comma_unit_error_detail import ( - GsaSymbolCannotContainCommaUnitErrorDetail, -) -from .gsa_t_item import GsaTItem from .gsa_table import GsaTable -from .gsa_table_creation_exception import GsaTableCreationException from .gsa_table_deletion_exception import GsaTableDeletionException -from .gsa_table_error_detail import GsaTableErrorDetail -from .gsa_table_error_reason import GsaTableErrorReason from .gsa_table_guid_property import GsaTableGuidProperty from .gsa_table_identity_property import GsaTableIdentityProperty from .gsa_table_name_property import GsaTableNameProperty -from .gsa_table_search_behaviour import GsaTableSearchBehaviour -from .gsa_table_type_contains_comma_error_detail import GsaTableTypeContainsCommaErrorDetail -from .gsa_table_type_error_detail import GsaTableTypeErrorDetail -from .gsa_table_type_error_reason import GsaTableTypeErrorReason -from .gsa_table_types_error_detail import GsaTableTypesErrorDetail -from .gsa_table_types_info import GsaTableTypesInfo -from .gsa_table_update_exception import GsaTableUpdateException from .gsa_tables_info import GsaTablesInfo from .gsa_tabular_attribute import GsaTabularAttribute -from .gsa_tabular_attribute_link import GsaTabularAttributeLink from .gsa_tabular_attribute_target import GsaTabularAttributeTarget from .gsa_tabular_attribute_usage_data_modification_error_detail import ( GsaTabularAttributeUsageDataModificationErrorDetail, @@ -1457,9 +964,6 @@ ) from .gsa_tabular_column_no_such_entity_type import GsaTabularColumnNoSuchEntityType from .gsa_tabular_column_roll_up_type import GsaTabularColumnRollUpType -from .gsa_tabular_column_usage_data_modification_error_detail import ( - GsaTabularColumnUsageDataModificationErrorDetail, -) from .gsa_tabular_datum import GsaTabularDatum from .gsa_tabular_datum_cell import GsaTabularDatumCell from .gsa_tabular_datum_exists_criterion import GsaTabularDatumExistsCriterion @@ -1468,94 +972,42 @@ from .gsa_tabular_datum_summary_row import GsaTabularDatumSummaryRow from .gsa_tabular_linking_value_criterion import GsaTabularLinkingValueCriterion from .gsa_tabular_row_export_behavior import GsaTabularRowExportBehavior -from .gsa_target_attribute import GsaTargetAttribute from .gsa_target_attribute_not_in_table_attribute_error_detail import ( GsaTargetAttributeNotInTableAttributeErrorDetail, ) -from .gsa_target_attribute_type import GsaTargetAttributeType from .gsa_target_attribute_type_attribute_error_detail import ( GsaTargetAttributeTypeAttributeErrorDetail, ) from .gsa_term_with_count import GsaTermWithCount from .gsa_text_match_behavior import GsaTextMatchBehavior from .gsa_threshold_type_attribute_error_detail import GsaThresholdTypeAttributeErrorDetail -from .gsa_too_long_code_currency_error_detail import GsaTooLongCodeCurrencyErrorDetail -from .gsa_too_many_attribute_pairs_smart_attributes_error_detail import ( - GsaTooManyAttributePairsSmartAttributesErrorDetail, -) -from .gsa_too_many_permissions_permission_category_error_detail import ( - GsaTooManyPermissionsPermissionCategoryErrorDetail, -) -from .gsa_too_many_permissions_replace_permission_category_error_detail import ( - GsaTooManyPermissionsReplacePermissionCategoryErrorDetail, -) -from .gsa_translate_between_guids_and_identities_response import ( - GsaTranslateBetweenGuidsAndIdentitiesResponse, -) from .gsa_translate_guids_to_identities_request import GsaTranslateGuidsToIdentitiesRequest -from .gsa_translate_identities_to_guids_request import GsaTranslateIdentitiesToGuidsRequest +from .gsa_translate_guids_to_identities_response import GsaTranslateGuidsToIdentitiesResponse from .gsa_unable_to_connect_add_database_validation_issue import ( GsaUnableToConnectAddDatabaseValidationIssue, ) from .gsa_unavailable_tabular_column import GsaUnavailableTabularColumn from .gsa_unit import GsaUnit -from .gsa_unit_as_exponent_unit_equation_error_detail import ( - GsaUnitAsExponentUnitEquationErrorDetail, -) from .gsa_unit_conversion_set import GsaUnitConversionSet from .gsa_unit_conversion_set_request import GsaUnitConversionSetRequest from .gsa_unit_conversions_info import GsaUnitConversionsInfo -from .gsa_unit_creation_exception import GsaUnitCreationException -from .gsa_unit_deletion_exception import GsaUnitDeletionException -from .gsa_unit_equation_error_detail import GsaUnitEquationErrorDetail -from .gsa_unit_equation_error_reason import GsaUnitEquationErrorReason from .gsa_unit_equivalent import GsaUnitEquivalent -from .gsa_unit_equivalent_error_detail import GsaUnitEquivalentErrorDetail -from .gsa_unit_equivalent_error_reason import GsaUnitEquivalentErrorReason from .gsa_unit_equivalents_info import GsaUnitEquivalentsInfo -from .gsa_unit_error_detail import GsaUnitErrorDetail -from .gsa_unit_error_reason import GsaUnitErrorReason from .gsa_unit_mapping import GsaUnitMapping from .gsa_unit_system import GsaUnitSystem from .gsa_unit_systems_info import GsaUnitSystemsInfo -from .gsa_unit_update_exception import GsaUnitUpdateException from .gsa_unit_usage import GsaUnitUsage -from .gsa_unit_usage_data_modification_error_detail import GsaUnitUsageDataModificationErrorDetail -from .gsa_unit_usage_type import GsaUnitUsageType -from .gsa_units_grouping_info import GsaUnitsGroupingInfo from .gsa_units_info import GsaUnitsInfo -from .gsa_unknown_unit_symbol_unit_equation_error_detail import ( - GsaUnknownUnitSymbolUnitEquationErrorDetail, -) -from .gsa_unresolved_attribute_guids_error_detail import GsaUnresolvedAttributeGuidsErrorDetail -from .gsa_unresolved_cross_database_record_link_group_guids_error_detail import ( - GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail, -) -from .gsa_unresolved_parameter_guids_error_detail import GsaUnresolvedParameterGuidsErrorDetail -from .gsa_unresolved_record_link_group_guids_error_detail import ( - GsaUnresolvedRecordLinkGroupGuidsErrorDetail, -) -from .gsa_unresolved_target_attribute import GsaUnresolvedTargetAttribute -from .gsa_update_access_control import GsaUpdateAccessControl -from .gsa_update_access_control_category import GsaUpdateAccessControlCategory -from .gsa_update_access_control_category_table_mapping import ( - GsaUpdateAccessControlCategoryTableMapping, -) from .gsa_update_all_profiles_info import GsaUpdateAllProfilesInfo from .gsa_update_attribute import GsaUpdateAttribute -from .gsa_update_attribute_based_access_control import GsaUpdateAttributeBasedAccessControl from .gsa_update_axis_name import GsaUpdateAxisName from .gsa_update_configuration import GsaUpdateConfiguration from .gsa_update_constant import GsaUpdateConstant from .gsa_update_continuous_range import GsaUpdateContinuousRange from .gsa_update_cross_database_record_link_group import GsaUpdateCrossDatabaseRecordLinkGroup -from .gsa_update_current_rule_engine import GsaUpdateCurrentRuleEngine from .gsa_update_data_rule import GsaUpdateDataRule from .gsa_update_database import GsaUpdateDatabase -from .gsa_update_database_security_groups import GsaUpdateDatabaseSecurityGroups from .gsa_update_date_time_attribute import GsaUpdateDateTimeAttribute -from .gsa_update_default_database import GsaUpdateDefaultDatabase -from .gsa_update_default_fallback_security_groups import GsaUpdateDefaultFallbackSecurityGroups from .gsa_update_default_profile import GsaUpdateDefaultProfile from .gsa_update_discrete_attribute import GsaUpdateDiscreteAttribute from .gsa_update_discrete_functional_attribute import GsaUpdateDiscreteFunctionalAttribute @@ -1573,8 +1025,7 @@ from .gsa_update_discrete_parameter_value import GsaUpdateDiscreteParameterValue from .gsa_update_discrete_range import GsaUpdateDiscreteRange from .gsa_update_discrete_type import GsaUpdateDiscreteType -from .gsa_update_display_names import GsaUpdateDisplayNames -from .gsa_update_display_names_response import GsaUpdateDisplayNamesResponse +from .gsa_update_dynamic_record_link_group import GsaUpdateDynamicRecordLinkGroup from .gsa_update_expression import GsaUpdateExpression from .gsa_update_file import GsaUpdateFile from .gsa_update_file_attribute import GsaUpdateFileAttribute @@ -1593,7 +1044,6 @@ from .gsa_update_integer_attribute import GsaUpdateIntegerAttribute from .gsa_update_job_request import GsaUpdateJobRequest from .gsa_update_layout import GsaUpdateLayout -from .gsa_update_layout_section import GsaUpdateLayoutSection from .gsa_update_linked_attribute_tabular_column import GsaUpdateLinkedAttributeTabularColumn from .gsa_update_linked_column_tabular_column import GsaUpdateLinkedColumnTabularColumn from .gsa_update_linked_record_tabular_column import GsaUpdateLinkedRecordTabularColumn @@ -1618,30 +1068,16 @@ from .gsa_update_parameter import GsaUpdateParameter from .gsa_update_parameter_content import GsaUpdateParameterContent from .gsa_update_parameter_value import GsaUpdateParameterValue -from .gsa_update_permission import GsaUpdatePermission -from .gsa_update_permission_access_control import GsaUpdatePermissionAccessControl -from .gsa_update_permission_based_access_control import GsaUpdatePermissionBasedAccessControl -from .gsa_update_permission_category import GsaUpdatePermissionCategory -from .gsa_update_permission_category_access_control import GsaUpdatePermissionCategoryAccessControl -from .gsa_update_permission_category_access_control_request import ( - GsaUpdatePermissionCategoryAccessControlRequest, -) from .gsa_update_picture_attribute import GsaUpdatePictureAttribute from .gsa_update_point_attribute import GsaUpdatePointAttribute from .gsa_update_profile import GsaUpdateProfile from .gsa_update_profile_table import GsaUpdateProfileTable -from .gsa_update_put_layout_item import GsaUpdatePutLayoutItem -from .gsa_update_put_permission import GsaUpdatePutPermission -from .gsa_update_put_permission_category import GsaUpdatePutPermissionCategory from .gsa_update_range_attribute import GsaUpdateRangeAttribute from .gsa_update_record_link_group import GsaUpdateRecordLinkGroup from .gsa_update_record_list_permission_flags import GsaUpdateRecordListPermissionFlags from .gsa_update_record_list_properties import GsaUpdateRecordListProperties from .gsa_update_replacement_string import GsaUpdateReplacementString -from .gsa_update_root_folder_error_detail import GsaUpdateRootFolderErrorDetail -from .gsa_update_run_status import GsaUpdateRunStatus from .gsa_update_short_text_attribute import GsaUpdateShortTextAttribute -from .gsa_update_smart_record_link_group import GsaUpdateSmartRecordLinkGroup from .gsa_update_standard_name import GsaUpdateStandardName from .gsa_update_static_record_link_group import GsaUpdateStaticRecordLinkGroup from .gsa_update_subset import GsaUpdateSubset @@ -1654,18 +1090,12 @@ from .gsa_update_unit_system import GsaUpdateUnitSystem from .gsa_update_user_permission import GsaUpdateUserPermission from .gsa_update_user_permissions_info import GsaUpdateUserPermissionsInfo -from .gsa_upgrade_database_exception import GsaUpgradeDatabaseException -from .gsa_upgrade_database_failure_reason import GsaUpgradeDatabaseFailureReason from .gsa_usage_data_modification_error_detail import GsaUsageDataModificationErrorDetail +from .gsa_user_or_group import GsaUserOrGroup from .gsa_user_permission import GsaUserPermission from .gsa_user_permissions_info import GsaUserPermissionsInfo from .gsa_user_role import GsaUserRole from .gsa_validate_attribute_request import GsaValidateAttributeRequest -from .gsa_validate_unit_equation_request import GsaValidateUnitEquationRequest -from .gsa_validate_unit_equation_response import GsaValidateUnitEquationResponse -from .gsa_value_not_provided_parameter_value_error_detail import ( - GsaValueNotProvidedParameterValueErrorDetail, -) from .gsa_value_specifier import GsaValueSpecifier from .gsa_value_specifier_type import GsaValueSpecifierType from .gsa_value_with_count_of_boolean import GsaValueWithCountOfBoolean @@ -1678,14 +1108,10 @@ from .gsa_version_number_property import GsaVersionNumberProperty from .gsa_version_state import GsaVersionState from .gsa_version_state_property import GsaVersionStateProperty -from .gsa_weighting_type import GsaWeightingType from .gsa_withdraw_record_version_control_exception import GsaWithdrawRecordVersionControlException -from .gsa_xy_chart_template import GsaXYChartTemplate from .gsa_xy_chart_template_usage_data_modification_error_detail import ( GsaXYChartTemplateUsageDataModificationErrorDetail, ) -from .gsa_xy_chart_templates_info import GsaXYChartTemplatesInfo -from .gsa_xy_template_axis import GsaXYTemplateAxis from .jobqueue_files_body import JobqueueFilesBody from .json_patch_document import JsonPatchDocument from .microsoft_asp_net_core_mvc_formatters_i_output_formatter import ( @@ -1710,39 +1136,12 @@ "FolderguidFilesBody1", "FolderguidFilesBody2", "GrantaMIRecordPropertyFakeAttributeIdentities", - "GrantaMISearchFreeTextIdentifiers", "GsaAboutAttributeCannotBeMetaAttributeErrorDetail", - "GsaAccessControlCategoriesInfo", - "GsaAccessControlCategory", - "GsaAccessControlCategoryCreationException", - "GsaAccessControlCategoryErrorDetail", - "GsaAccessControlCategoryErrorReason", - "GsaAccessControlCategoryInclude", - "GsaAccessControlCategoryNoSuchEntityType", - "GsaAccessControlCategoryTableMapping", - "GsaAccessControlCategoryUpdateException", - "GsaAccessControlInfo", - "GsaAccessControlMode", - "GsaAccessControlModeInfo", - "GsaActivityLogApplicationNameFilter", - "GsaActivityLogApplicationNamesCollectionFilter", - "GsaActivityLogCollectionMatchType", - "GsaActivityLogDatabaseKeyFilter", - "GsaActivityLogDateFilter", - "GsaActivityLogEntriesFilter", - "GsaActivityLogEntriesInfo", - "GsaActivityLogEntry", - "GsaActivityLogMatchType", - "GsaActivityLogUsageMode", - "GsaActivityLogUsageModeFilter", - "GsaActivityLogUsernameFilter", "GsaAddDatabase", "GsaAddDatabaseIssueType", - "GsaAddDatabaseSecurityGroups", "GsaAddDatabaseValidationIssue", "GsaAddDatabaseValidationResult", "GsaAddRecordHistoryToSubset", - "GsaAdditionalSqlParameters", "GsaAggregation", "GsaAggregationCriterion", "GsaAggregationDatum", @@ -1763,22 +1162,16 @@ "GsaAppendPointValues", "GsaApplicableDatum", "GsaApplicationsInfo", - "GsaApplyOptions", - "GsaAssociationChainCreatePutLayoutItem", "GsaAttribute", "GsaAttributeAggregation", "GsaAttributeAggregationCriterion", "GsaAttributeAggregationExistsCriterion", "GsaAttributeAggregationType", "GsaAttributeAggregationValueCriterion", - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "GsaAttributeBasedAccessControlInfo", - "GsaAttributeCreatePutLayoutItem", "GsaAttributeCreationException", "GsaAttributeCriterion", "GsaAttributeCriterionType", "GsaAttributeDeletionException", - "GsaAttributeDiscreteTypeMismatchErrorDetail", "GsaAttributeErrorDetail", "GsaAttributeErrorReason", "GsaAttributeExistsAggregation", @@ -1790,66 +1183,42 @@ "GsaAttributeMatchesCriterion", "GsaAttributeNoSuchEntityType", "GsaAttributeNotApplicableCriterion", - "GsaAttributeNotOnTableErrorDetail", - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail", "GsaAttributeReference", "GsaAttributeScaleType", "GsaAttributeSortCriterion", "GsaAttributeThresholdType", "GsaAttributeToExport", "GsaAttributeType", - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", "GsaAttributeUsageDataModificationErrorDetail", "GsaAttributeValidateResponse", "GsaAttributeValueAggregation", "GsaAttributesInfo", "GsaAxisName", - "GsaBlobInfoDto", "GsaBooleanCriterion", "GsaBoostByGuid", "GsaBoostByIdentity", - "GsaBracketMismatchUnitEquationErrorDetail", "GsaBulkInfo", "GsaBulkRequest", "GsaBulkRequestHttpMethod", "GsaBulkRequestItem", "GsaBulkResponseItem", "GsaCalendarInterval", - "GsaCategoryReplacePermissionCategoryErrorDetail", - "GsaChartData", - "GsaChartDataType", - "GsaCircularReferenceFolderMoveErrorDetail", - "GsaCodeMissingCurrencyErrorDetail", - "GsaCodeWhitespaceCurrencyErrorDetail", - "GsaConfigInvalidJsonFileErrorDetail", "GsaConfiguration", - "GsaConfigurationDetails", "GsaConfigurationsInfo", "GsaConnectionDetails", "GsaConstant", - "GsaConstantCreationException", "GsaConstantDeletionException", - "GsaConstantErrorDetail", - "GsaConstantErrorReason", - "GsaConstantUpdateException", - "GsaConstantUsageDataModificationErrorDetail", "GsaConstantsInfo", - "GsaContinuousQualitySystem", "GsaContinuousRange", "GsaCopyRecordHistory", - "GsaCreateAccessControlCategory", - "GsaCreateAccessControlCategoryTableMapping", "GsaCreateAttribute", "GsaCreateAttributeLinkPair", "GsaCreateAxisName", "GsaCreateConfiguration", "GsaCreateConstant", "GsaCreateContinuousRange", - "GsaCreateCrossDatabaseLinkTarget", "GsaCreateCrossDatabaseRecordLinkGroup", "GsaCreateDataRule", - "GsaCreateDataUpdateServerApiRequest", "GsaCreateDateTimeAttribute", "GsaCreateDiscreteAttribute", "GsaCreateDiscreteFunctionalAttribute", @@ -1861,6 +1230,7 @@ "GsaCreateDiscreteParameterValue", "GsaCreateDiscreteRange", "GsaCreateDiscreteType", + "GsaCreateDynamicRecordLinkGroup", "GsaCreateExpression", "GsaCreateFileAttribute", "GsaCreateFloatFunctionalAttribute", @@ -1898,47 +1268,31 @@ "GsaCreateParameter", "GsaCreateParameterContent", "GsaCreateParameterValue", - "GsaCreatePermission", - "GsaCreatePermissionCategory", "GsaCreatePictureAttribute", "GsaCreatePointAttribute", "GsaCreateProfile", "GsaCreateProfileTable", - "GsaCreatePutLayoutItem", - "GsaCreatePutPermission", - "GsaCreatePutPermissionCategory", "GsaCreateRangeAttribute", "GsaCreateRecordHistory", "GsaCreateRecordLinkGroup", "GsaCreateRecordList", "GsaCreateRecordListItemsInfo", "GsaCreateReplacementString", + "GsaCreateSearchRequest", "GsaCreateShortTextAttribute", - "GsaCreateSmartLinkTarget", - "GsaCreateSmartRecordLinkGroup", "GsaCreateStandardName", - "GsaCreateStaticLinkTarget", "GsaCreateStaticRecordLinkGroup", "GsaCreateSubset", "GsaCreateTable", "GsaCreateTabularAttribute", "GsaCreateTabularColumn", "GsaCreateUnit", - "GsaCreateUnitMapping", "GsaCreateUnitSystem", "GsaCreatedByUserProperty", "GsaCreatedDateProperty", "GsaCriterion", "GsaCriterionType", - "GsaCrossDatabaseLink", - "GsaCrossDatabaseLinkCreatePutLayoutItem", - "GsaCrossDatabaseRecordLink", "GsaCrossDatabaseRecordLinkGroup", - "GsaCrossDatabaseRecordLinkResult", - "GsaCurrenciesInfo", - "GsaCurrency", - "GsaCurrencyErrorDetail", - "GsaCurrencyErrorReason", "GsaCurrentUser", "GsaDataExportApplicableDatum", "GsaDataExportBinaryData", @@ -1988,25 +1342,11 @@ "GsaDataModificationErrorReason", "GsaDataRule", "GsaDataRulesInfo", - "GsaDataSource", - "GsaDataUpdate", - "GsaDataUpdateHeader", - "GsaDataUpdateRunInfo", - "GsaDataUpdateToken", - "GsaDataUpdaterJob", - "GsaDataUpdaterJobStatus", - "GsaDataUpdaterJobType", - "GsaDataUpdaterProject", "GsaDataUsageDataModificationErrorDetail", "GsaDatabase", - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "GsaDatabaseIssues", "GsaDatabaseKeyProperty", - "GsaDatabaseSecurityGroups", - "GsaDatabaseSecurityGroupsInfo", "GsaDatabaseStatus", "GsaDatabaseStatusInformation", - "GsaDatabaseUserCapabilities", "GsaDatabasesInfo", "GsaDateTimeAggregation", "GsaDateTimeAggregationDatumCriterion", @@ -2034,20 +1374,11 @@ "GsaDatumRollupType", "GsaDatumType", "GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail", - "GsaDefaultFallbackSecurityGroups", "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail", - "GsaDefaultLayoutGuidErrorDetail", - "GsaDefaultParameterValueGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "GsaDefaultParameterValueIndexParameterErrorDetail", - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", "GsaDefaultParameterValueUsageDataModificationErrorDetail", - "GsaDefaultSubsetGuidErrorDetail", "GsaDeleteRecordListItem", "GsaDeleteRecordListItems", - "GsaDescriptionLengthFileErrorDetail", "GsaDiscreteAttribute", - "GsaDiscreteChartData", "GsaDiscreteDatum", "GsaDiscreteDatumExistsCriterion", "GsaDiscreteFunctionalAttribute", @@ -2074,7 +1405,6 @@ "GsaDiscreteParameterNameConstraint", "GsaDiscreteParameterValue", "GsaDiscreteParameterValueConstraint", - "GsaDiscreteQualitySystem", "GsaDiscreteRange", "GsaDiscreteRangeDatumCriterion", "GsaDiscreteSeries", @@ -2088,60 +1418,32 @@ "GsaDiscreteType", "GsaDiscreteTypeDeletionException", "GsaDiscreteTypeUsage", - "GsaDiscreteTypeUsageType", "GsaDiscreteTypesInfo", "GsaDiscreteValue", "GsaDiscreteValueAggregateErrorReason", "GsaDiscreteValueAggregateException", - "GsaDiscreteValueNotInDiscreteTypeErrorDetail", "GsaDiscreteValuesCreateDiscreteValue", "GsaDiscreteValuesDiscreteValue", "GsaDiscreteValuesDiscreteValuesInfo", "GsaDiscreteValuesReplaceDiscreteValuesInfo", "GsaDiscreteValuesUpdateDiscreteValue", "GsaDiskStatus", - "GsaDisplayNameEmptyErrorDetail", - "GsaDisplayNameLanguageNotProvidedErrorDetail", - "GsaDisplayNameLanguageNotSupportedErrorDetail", - "GsaDisplayNamesImportErrorDetail", - "GsaDisplayNamesImportErrorReason", - "GsaDisplayNamesImportException", - "GsaDisplayNamesInfo", - "GsaDivideByZeroUnitEquationErrorDetail", "GsaDoubleSortingValue", - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "GsaDuplicateCodeCurrencyErrorDetail", "GsaDuplicateDatabaseAddDatabaseValidationIssue", - "GsaDuplicateDiscreteValueErrorDetail", "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail", "GsaDuplicateGuidAddDatabaseValidationIssue", "GsaDuplicateKeyAddDatabaseValidationIssue", - "GsaDuplicateMappedAttributeGuidsErrorDetail", - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateMappedParameterGuidsErrorDetail", - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "GsaDuplicateNameCurrencyErrorDetail", "GsaDuplicateParameterGuidsAttributeErrorDetail", - "GsaDuplicatePermissionGuidsAccessControlErrorDetail", - "GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "GsaDuplicateSymbolUnitErrorDetail", - "GsaDuplicateTableErrorDetail", "GsaDuplicateTabularColumnGuidsErrorDetail", "GsaDuplicateTabularColumnNamesErrorDetail", "GsaDuplicateVersionGuidAddDatabaseValidationIssue", + "GsaDynamicLinkGroupUsageDataModificationErrorDetail", + "GsaDynamicRecordLinkGroup", "GsaEmptyAxisNameAttributeErrorDetail", - "GsaEmptySymbolUnitErrorDetail", - "GsaEmptyTableTypeErrorDetail", "GsaEnabledLicensesInfo", "GsaEntityAlreadyExistsErrorDetail", "GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "GsaEntityType", - "GsaEquationUnitErrorDetail", - "GsaErrorCode", "GsaErrorDetail", - "GsaErrorResponse", - "GsaExceptionInformation", "GsaExcludeValuesSpecifier", "GsaExistingTabularColumnGuidErrorDetail", "GsaExportFailure", @@ -2152,28 +1454,14 @@ "GsaExpressionUsageDataModificationErrorDetail", "GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail", "GsaExpressionsInfo", - "GsaFileAlreadyExistsFileMoveErrorDetail", "GsaFileAttribute", - "GsaFileCreationException", "GsaFileDatum", "GsaFileDatumCriterion", "GsaFileDatumExistsCriterion", - "GsaFileErrorDetail", - "GsaFileErrorReason", "GsaFileHeader", - "GsaFileHeaderInfo", - "GsaFileMoveErrorDetail", - "GsaFileMoveErrorReason", - "GsaFileMoveException", - "GsaFileNameFileErrorDetail", - "GsaFileNameFolderErrorDetail", "GsaFilePrefixDatumCriterion", - "GsaFileUpdateException", "GsaFilesInfo", - "GsaFindSimilarRequest", - "GsaFindSimilarResponse", - "GsaFindSimilarResult", - "GsaFindSimilarSearchCriterion", + "GsaFindSearchRequest", "GsaFindStandardNames", "GsaFloatFunctionalAggregation", "GsaFloatFunctionalAggregationDatumCriterion", @@ -2195,20 +1483,7 @@ "GsaFloatSeriesGraph", "GsaFloatSeriesPoint", "GsaFolder", - "GsaFolderAlreadyExistsFolderMoveErrorDetail", - "GsaFolderCreationException", - "GsaFolderDeletionErrorDetail", - "GsaFolderDeletionErrorReason", - "GsaFolderDeletionException", - "GsaFolderErrorDetail", - "GsaFolderErrorReason", - "GsaFolderMoveErrorDetail", - "GsaFolderMoveErrorReason", - "GsaFolderMoveException", - "GsaFolderType", - "GsaFolderUpdateException", "GsaFoldersInfo", - "GsaForbidOrphansRecordLinkGroupErrorDetail", "GsaFreeTextAggregation", "GsaFreeTextAggregationCriterion", "GsaFreeTextCriterion", @@ -2216,17 +1491,14 @@ "GsaFullLayoutSection", "GsaFullNameProperty", "GsaFuncNoParamsAttributeErrorDetail", - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail", "GsaFunctionalDatumParameterInfo", "GsaFunctionalParameterSetting", "GsaFunctionalType", - "GsaGeneralUnitEquationErrorDetail", "GsaGeneratedIntegrationSchemaOfObjectIdentifier", "GsaGetJobsResponse", "GsaGetJobsSummaryResponse", "GsaGetModifiableRecordVersionControlException", "GsaGetUnitConversionsRequest", - "GsaGetUnitEquivalentsException", "GsaGraph", "GsaGraphDecorationType", "GsaGraphEvaluationSettings", @@ -2235,7 +1507,6 @@ "GsaGraphType", "GsaGraphValue", "GsaGraphValueType", - "GsaGrid", "GsaGridGraph", "GsaGuidOnlyAttribute", "GsaGuidOnlyDiscreteType", @@ -2244,7 +1515,6 @@ "GsaGuidOnlyLayout", "GsaGuidOnlyMappingOfObjectIdentifier", "GsaGuidOnlySourceOfObjectIdentifier", - "GsaHelpPathsValidationResponse", "GsaHistogram", "GsaHistogramBucket", "GsaHyperlinkAttribute", @@ -2253,17 +1523,12 @@ "GsaHyperlinkDatumExistsCriterion", "GsaHyperlinkPrefixDatumCriterion", "GsaHyperlinkTarget", - "GsaInUseParameterValueErrorDetail", - "GsaInclusiveness", - "GsaIncompatibleUnitsErrorDetail", "GsaIndexRecordFailure", "GsaIndirectLinks", - "GsaInputConnectionDetails", "GsaInputValidationErrorDetail", "GsaIntegerAggregation", "GsaIntegerAggregationDatumCriterion", "GsaIntegerAttribute", - "GsaIntegerChartData", "GsaIntegerDatum", "GsaIntegerDatumCriterion", "GsaIntegerDatumExistsCriterion", @@ -2278,8 +1543,6 @@ "GsaIntegrationSchemaGenerationErrorDetail", "GsaIntegrationSchemaOfObjectIdentifier", "GsaIntegrationSchemaStatus", - "GsaInvalidEquivalenceTargetErrorDetail", - "GsaInvalidExchangeRateCurrencyErrorDetail", "GsaInvalidKeyAddDatabaseValidationIssue", "GsaInvalidParentStateErrorDetail", "GsaInvalidVersionStateErrorDetail", @@ -2299,7 +1562,6 @@ "GsaLayoutSectionsInfo", "GsaLayoutTabularColumn", "GsaLayoutsInfo", - "GsaLink", "GsaLinkAggregation", "GsaLinkAggregationDatumCriterion", "GsaLinkAttributeToExport", @@ -2352,11 +1614,9 @@ "GsaLocalRangeTabularColumn", "GsaLocalRowsBehavior", "GsaLocalShortTextTabularColumn", - "GsaLogScaleNegativeParameterValueErrorDetail", "GsaLogicalAggregation", "GsaLogicalAggregationDatumCriterion", "GsaLogicalAttribute", - "GsaLogicalChartData", "GsaLogicalDatum", "GsaLogicalDatumCriterion", "GsaLogicalDatumExistsCriterion", @@ -2366,9 +1626,7 @@ "GsaLongTextDatumCriterion", "GsaLongTextDatumExistsCriterion", "GsaLongTextPrefixDatumCriterion", - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", "GsaMappingOfObjectIdentifier", - "GsaMatchMode", "GsaMathsContent", "GsaMathsFunctionalAttribute", "GsaMathsFunctionalAttributeErrorDetail", @@ -2376,8 +1634,6 @@ "GsaMathsFunctionalDatumExistsCriterion", "GsaMathsFunctionalErrorDetail", "GsaMathsFunctionalErrorReason", - "GsaMaxPermissionsReachedPermissionErrorDetail", - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", "GsaMfaExpressionErrorDetail", "GsaMfaExpressionErrorReason", "GsaMiVersion", @@ -2386,30 +1642,12 @@ "GsaMoveFile", "GsaMoveFolder", "GsaMoveRecordHistory", - "GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", "GsaNameAlreadyExistsErrorDetail", - "GsaNameAlreadySpecifiedErrorDetail", - "GsaNameMissingCurrencyErrorDetail", "GsaNameNotProvidedErrorDetail", - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "GsaNameWhitespaceCurrencyErrorDetail", - "GsaNameWhitespaceParameterValueErrorDetail", "GsaNamedCriterion", - "GsaNamedEntityAccessControlCategoryErrorDetail", "GsaNamedEntityAttributeErrorDetail", - "GsaNamedEntityConstantErrorDetail", "GsaNamedEntityErrorDetail", "GsaNamedEntityErrorReason", - "GsaNamedEntityFileErrorDetail", - "GsaNamedEntityFolderErrorDetail", - "GsaNamedEntityParameterErrorDetail", - "GsaNamedEntityParameterValueErrorDetail", - "GsaNamedEntityPermissionErrorDetail", - "GsaNamedEntityRecordLinkGroupErrorDetail", - "GsaNamedEntityTableErrorDetail", - "GsaNamedEntityUnitErrorDetail", "GsaNewLayoutAssociationChainItem", "GsaNewLayoutAssociationChainLink", "GsaNewLayoutAttributeItem", @@ -2418,47 +1656,23 @@ "GsaNewLayoutItemType", "GsaNewLayoutRecordLinkItem", "GsaNewLayoutSmartLinkItem", - "GsaNoAttributePairsSmartAttributesErrorDetail", - "GsaNoDataFileErrorDetail", "GsaNoExpressionsMathsFunctionalErrorDetail", - "GsaNoFileFileErrorDetail", - "GsaNoParameterValuesParameterErrorDetail", - "GsaNoPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchAttributeSmartAttributesErrorDetail", - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "GsaNoSuchCategoryAccessControlErrorDetail", - "GsaNoSuchEntityAccessControlCategoryErrorDetail", "GsaNoSuchEntityAttributeErrorDetail", "GsaNoSuchEntityTabularColumnErrorDetail", "GsaNoSuchExpressionsMathsFunctionalErrorDetail", - "GsaNoSuchNewParentFileMoveErrorDetail", - "GsaNoSuchNewParentFolderMoveErrorDetail", "GsaNoSuchParameterValueParameterContentErrorDetail", - "GsaNoSuchPermissionAccessControlErrorDetail", - "GsaNoSuchPermissionsPermissionCategoryErrorDetail", - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "GsaNoSuchUnitConstantErrorDetail", - "GsaNoSuchUnitParameterErrorDetail", - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "GsaNoSuchUnitUnitEquivalentErrorDetail", "GsaNoValueExistsGraphValue", "GsaNoValuesSpecifier", - "GsaNonCustomStandardNameCannotBeChangedErrorDetail", "GsaNotApplicableDatum", "GsaNotTheLatestVersionErrorDetail", "GsaNotVersionedErrorDetail", - "GsaNumberParsingUnitEquationErrorDetail", "GsaNumericGraphParameterValue", "GsaNumericParameter", "GsaNumericParameterConstraint", "GsaNumericParameterContent", "GsaNumericParameterDataValue", "GsaNumericParameterValue", - "GsaNumericRestrictedInterpolationParameterErrorDetail", "GsaObjectIdentifier", - "GsaPaginatedItemType", - "GsaPaginatedResponseOf", - "GsaPaginationLinks", "GsaPagingOptions", "GsaParameter", "GsaParameterConstraint", @@ -2470,11 +1684,8 @@ "GsaParameterContentMathsFunctionalErrorDetail", "GsaParameterContentMissingArgument", "GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", - "GsaParameterCreationException", "GsaParameterDataValue", "GsaParameterDeletionException", - "GsaParameterErrorDetail", - "GsaParameterErrorReason", "GsaParameterInfo", "GsaParameterInfoInterpolationType", "GsaParameterInfoParameterType", @@ -2484,44 +1695,14 @@ "GsaParameterSettingDefinedAt", "GsaParameterType", "GsaParameterTypeParameterContentErrorDetail", - "GsaParameterTypeParameterErrorDetail", - "GsaParameterUpdateException", - "GsaParameterUsageDataModificationErrorDetail", "GsaParameterValue", - "GsaParameterValueCreationException", "GsaParameterValueDeletionException", - "GsaParameterValueErrorDetail", - "GsaParameterValueErrorReason", - "GsaParameterValueParameterErrorDetail", "GsaParameterValueType", - "GsaParameterValueTypeParameterValueErrorDetail", - "GsaParameterValueUpdateException", - "GsaParameterValueUsedByType", "GsaParameterWithDataValue", "GsaParametersInfo", "GsaPermission", - "GsaPermissionAccessControl", - "GsaPermissionBasedAccessControlInfo", - "GsaPermissionCategoriesAccessControlErrorDetail", - "GsaPermissionCategoriesAccessControlErrorReason", - "GsaPermissionCategoriesAccessControlUpdateException", "GsaPermissionCategoriesInfo", "GsaPermissionCategory", - "GsaPermissionCategoryAccessControl", - "GsaPermissionCategoryAccessControlInfo", - "GsaPermissionCategoryCreationException", - "GsaPermissionCategoryErrorDetail", - "GsaPermissionCategoryErrorReason", - "GsaPermissionCategoryReplaceException", - "GsaPermissionCategoryUpdateException", - "GsaPermissionCreationException", - "GsaPermissionDeletionErrorDetail", - "GsaPermissionDeletionErrorReason", - "GsaPermissionDeletionException", - "GsaPermissionErrorDetail", - "GsaPermissionErrorReason", - "GsaPermissionPermissionCategoryErrorDetail", - "GsaPermissionUpdateException", "GsaPermissionsInfo", "GsaPictureAttribute", "GsaPictureDatum", @@ -2530,7 +1711,6 @@ "GsaPointAggregation", "GsaPointAggregationDatumCriterion", "GsaPointAttribute", - "GsaPointChartData", "GsaPointDataValue", "GsaPointDatum", "GsaPointDatumCriterion", @@ -2544,15 +1724,6 @@ "GsaProfileTable", "GsaProfileTablesInfo", "GsaProperty", - "GsaPutLayoutItem", - "GsaPutPermission", - "GsaPutPermissionCategory", - "GsaPutType", - "GsaQualityDiscreteValue", - "GsaQualitySystem", - "GsaQualitySystemGuidErrorDetail", - "GsaQualitySystemType", - "GsaQualitySystemsInfo", "GsaQueryAttribute", "GsaQueryAttributeFilter", "GsaQueryAttributeInfo", @@ -2569,25 +1740,9 @@ "GsaQueryDiscreteTypeProperties", "GsaQueryDiscreteTypesInfo", "GsaQueryDiscreteTypesRequest", - "GsaQueryLayout", - "GsaQueryLayoutFilter", - "GsaQueryLayoutItem", - "GsaQueryLayoutItemFilter", - "GsaQueryLayoutItemProperties", - "GsaQueryLayoutProperties", - "GsaQueryLayoutSection", - "GsaQueryLayoutSectionFilter", - "GsaQueryLayoutSectionProperties", - "GsaQueryLayoutSectionsInfo", - "GsaQueryLayoutSectionsRequest", - "GsaQueryLayoutsInfo", - "GsaQueryLayoutsRequest", "GsaQuerySlimDiscreteType", "GsaQuerySlimDiscreteTypeProperties", - "GsaQuerySlimEntity", - "GsaQuerySlimEntityProperties", "GsaQuerySlimNamedEntity", - "GsaQuerySlimNamedEntityFilter", "GsaQuerySlimNamedEntityProperties", "GsaQuerySlimTypedAttribute", "GsaQuerySlimTypedAttributeProperties", @@ -2598,25 +1753,21 @@ "GsaQueryTablesRequest", "GsaQueryTabularAttributeTarget", "GsaQueryTabularAttributeTargetProperties", - "GsaQueryTabularColumn", - "GsaQueryTabularColumnProperties", "GsaQueryUnit", "GsaQueryUnitProperties", "GsaRangeAggregation", "GsaRangeAggregationDatumCriterion", "GsaRangeAttribute", - "GsaRangeChartData", "GsaRangeDatum", "GsaRangeDatumCriterion", "GsaRangeDatumExistsCriterion", - "GsaRangeEndpoint", "GsaRangeFixedWidthHistogramAggregationDatumCriterion", "GsaRangeGraphValue", "GsaRangeHistogramAggregation", "GsaRangeHistogramAggregationDatumCriterion", "GsaRecordAncestorCriterion", "GsaRecordAncestorHistoryCriterion", - "GsaRecordAndAttributeSelectionType", + "GsaRecordCapabilities", "GsaRecordColor", "GsaRecordColorProperty", "GsaRecordExportFailure", @@ -2626,18 +1777,9 @@ "GsaRecordHistoryGuidProperty", "GsaRecordHistoryMoveException", "GsaRecordHistoryReference", - "GsaRecordLink", - "GsaRecordLinkBase", - "GsaRecordLinkCreatePutLayoutItem", "GsaRecordLinkGroup", - "GsaRecordLinkGroupCreationException", - "GsaRecordLinkGroupErrorDetail", - "GsaRecordLinkGroupErrorReason", "GsaRecordLinkGroupType", - "GsaRecordLinkGroupUpdateException", "GsaRecordLinkGroupsInfo", - "GsaRecordLinkResult", - "GsaRecordLinkResults", "GsaRecordListHeader", "GsaRecordListHeadersInfo", "GsaRecordListItemsInfo", @@ -2657,74 +1799,45 @@ "GsaRecordReferenceType", "GsaRecordSubsetCriterion", "GsaRecordType", - "GsaRecordTypeCriterion", "GsaRecordTypeProperty", - "GsaRecordUserCapabilities", "GsaRecordVersion", "GsaRecordVersionReference", "GsaRecordWithData", "GsaReferencedByType", "GsaReferentialIntegrityModel", - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "GsaRegisterUpdateRequest", "GsaReleaseRecordVersionControlException", "GsaReleaseTableVersionControlException", "GsaReleasedDateProperty", "GsaRelevanceSortCriterion", "GsaRemoveRecordHistoryFromSubset", "GsaReorderSectionsInfo", - "GsaReplacePermissionCategoriesRequest", - "GsaReplacePermissionCategoryErrorDetail", - "GsaReplacePermissionCategoryErrorReason", "GsaReplacementString", "GsaReplacementStringsInfo", - "GsaResolveLinkTargetsInfo", - "GsaResolveLinkTargetsRequest", + "GsaResolvedLink", + "GsaResolvedLinkInfo", "GsaResolvedLinkTarget", - "GsaResolvedTargetAttribute", "GsaResponseOptions", "GsaResubmitJobRequest", - "GsaRetargetPotentialRequest", - "GsaRetargetRequest", - "GsaRetargetResult", - "GsaRetargetResultType", - "GsaRetargetResultsInfo", - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", "GsaRichTextType", "GsaRichTextValue", - "GsaRoleNotProvidedPermissionErrorDetail", "GsaRollupExportFailure", "GsaRollupReference", - "GsaRootFolderMoveErrorDetail", - "GsaRootRecordNotAvailableToRenameErrorDetail", - "GsaRuleEngine", - "GsaSameParentFileMoveErrorDetail", - "GsaSameParentFolderMoveErrorDetail", + "GsaSaveSearchRequest", "GsaSchemaTooNewAddDatabaseValidationIssue", "GsaSchemaTooOldAddDatabaseValidationIssue", "GsaSearchClusterStatus", + "GsaSearchDetail", "GsaSearchIndexStatus", - "GsaSearchMask", - "GsaSearchMaskInfo", "GsaSearchMaskUsageDataModificationErrorDetail", "GsaSearchRequest", "GsaSearchResponse", "GsaSearchResult", "GsaSearchResultsRequest", - "GsaSearchServiceStatus", - "GsaSearchTemplate", - "GsaSearchTemplateAttributeItem", - "GsaSearchTemplateInfo", - "GsaSearchTemplateItem", - "GsaSearchTemplateItemType", - "GsaSearchTemplateLinkItem", - "GsaSearchTemplateTabularColumnItem", "GsaSearchableRecordProperty", + "GsaSecurityAttributeGrouping", "GsaSecurityAttributeUsageDataModificationErrorDetail", "GsaSecurityGroups", - "GsaSelection", + "GsaSelectionSearch", "GsaSeriesGraph", "GsaSetDateTimeDatum", "GsaSetDatum", @@ -2744,9 +1857,6 @@ "GsaSetShortTextDatum", "GsaSetTabularDatum", "GsaSetTabularDatumRow", - "GsaSetUnitEquivalent", - "GsaSetUnitEquivalentsException", - "GsaSetUnitEquivalentsInfo", "GsaShortNameProperty", "GsaShortTextAggregation", "GsaShortTextAggregationDatumCriterion", @@ -2756,12 +1866,10 @@ "GsaShortTextDatumExistsCriterion", "GsaShortTextPrefixDatumCriterion", "GsaSignificantFiguresInfo", - "GsaSimilaritySetting", - "GsaSimilaritySettings", "GsaSimpleAttributeToExport", "GsaSlimAttribute", - "GsaSlimAttributeWithHelpPath", "GsaSlimConfiguration", + "GsaSlimConstant", "GsaSlimDatabase", "GsaSlimDiscreteType", "GsaSlimEntity", @@ -2770,78 +1878,45 @@ "GsaSlimIdentifiedEntity", "GsaSlimLayout", "GsaSlimLayoutSection", - "GsaSlimLocalizedEntity", "GsaSlimNamedEntity", + "GsaSlimNamedUnit", "GsaSlimObjects", "GsaSlimParameter", - "GsaSlimParameterWithHelpPath", + "GsaSlimPermission", + "GsaSlimPermissionCategory", "GsaSlimProfile", "GsaSlimProfileTable", "GsaSlimRecordHistory", "GsaSlimRecordLinkGroup", "GsaSlimRecordVersion", "GsaSlimReplacementString", - "GsaSlimSearchMask", - "GsaSlimSearchTemplate", "GsaSlimSubset", "GsaSlimTable", "GsaSlimTypedAttribute", "GsaSlimUnit", - "GsaSmartAttributesErrorDetail", - "GsaSmartAttributesErrorReason", - "GsaSmartAttributesRecordLinkGroupErrorDetail", - "GsaSmartLink", - "GsaSmartLinkCreatePutLayoutItem", - "GsaSmartLinkGroupUsageDataModificationErrorDetail", - "GsaSmartRecordLinkGroup", - "GsaSmartRecordLinkResult", + "GsaSlimUnitSystem", + "GsaSmtpProperties", "GsaSortCriterion", "GsaSortCriterionType", "GsaSortDirection", "GsaSortType", "GsaSortingValue", "GsaSortingValueType", - "GsaSourceCannotBeTargetSmartAttributesErrorDetail", "GsaSourceOfObjectIdentifier", "GsaSpecificValuesSpecifier", - "GsaSqlCredentials", "GsaStandardName", - "GsaStandardNameAlreadyExistsErrorDetail", - "GsaStandardNameCreationException", - "GsaStandardNameDeletionErrorDetail", - "GsaStandardNameDeletionErrorReason", - "GsaStandardNameDeletionException", - "GsaStandardNameErrorDetail", - "GsaStandardNameErrorReason", - "GsaStandardNameUpdateException", "GsaStandardNamesInfo", - "GsaStaticRecordLink", "GsaStaticRecordLinkGroup", - "GsaStaticRecordLinkResult", "GsaStringSortingValue", "GsaSubset", "GsaSubsetsInfo", - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - "GsaSymbolCannotContainCommaUnitErrorDetail", - "GsaTItem", "GsaTable", - "GsaTableCreationException", "GsaTableDeletionException", - "GsaTableErrorDetail", - "GsaTableErrorReason", "GsaTableGuidProperty", "GsaTableIdentityProperty", "GsaTableNameProperty", - "GsaTableSearchBehaviour", - "GsaTableTypeContainsCommaErrorDetail", - "GsaTableTypeErrorDetail", - "GsaTableTypeErrorReason", - "GsaTableTypesErrorDetail", - "GsaTableTypesInfo", - "GsaTableUpdateException", "GsaTablesInfo", "GsaTabularAttribute", - "GsaTabularAttributeLink", "GsaTabularAttributeTarget", "GsaTabularAttributeUsageDataModificationErrorDetail", "GsaTabularAttributeWithColumns", @@ -2850,7 +1925,6 @@ "GsaTabularColumnNameNotProvidedErrorDetail", "GsaTabularColumnNoSuchEntityType", "GsaTabularColumnRollUpType", - "GsaTabularColumnUsageDataModificationErrorDetail", "GsaTabularDatum", "GsaTabularDatumCell", "GsaTabularDatumExistsCriterion", @@ -2859,70 +1933,36 @@ "GsaTabularDatumSummaryRow", "GsaTabularLinkingValueCriterion", "GsaTabularRowExportBehavior", - "GsaTargetAttribute", "GsaTargetAttributeNotInTableAttributeErrorDetail", - "GsaTargetAttributeType", "GsaTargetAttributeTypeAttributeErrorDetail", "GsaTermWithCount", "GsaTextMatchBehavior", "GsaThresholdTypeAttributeErrorDetail", - "GsaTooLongCodeCurrencyErrorDetail", - "GsaTooManyAttributePairsSmartAttributesErrorDetail", - "GsaTooManyPermissionsPermissionCategoryErrorDetail", - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - "GsaTranslateBetweenGuidsAndIdentitiesResponse", "GsaTranslateGuidsToIdentitiesRequest", - "GsaTranslateIdentitiesToGuidsRequest", + "GsaTranslateGuidsToIdentitiesResponse", "GsaUnableToConnectAddDatabaseValidationIssue", "GsaUnavailableTabularColumn", "GsaUnit", - "GsaUnitAsExponentUnitEquationErrorDetail", "GsaUnitConversionSet", "GsaUnitConversionSetRequest", "GsaUnitConversionsInfo", - "GsaUnitCreationException", - "GsaUnitDeletionException", - "GsaUnitEquationErrorDetail", - "GsaUnitEquationErrorReason", "GsaUnitEquivalent", - "GsaUnitEquivalentErrorDetail", - "GsaUnitEquivalentErrorReason", "GsaUnitEquivalentsInfo", - "GsaUnitErrorDetail", - "GsaUnitErrorReason", "GsaUnitMapping", "GsaUnitSystem", "GsaUnitSystemsInfo", - "GsaUnitUpdateException", "GsaUnitUsage", - "GsaUnitUsageDataModificationErrorDetail", - "GsaUnitUsageType", - "GsaUnitsGroupingInfo", "GsaUnitsInfo", - "GsaUnknownUnitSymbolUnitEquationErrorDetail", - "GsaUnresolvedAttributeGuidsErrorDetail", - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedParameterGuidsErrorDetail", - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "GsaUnresolvedTargetAttribute", - "GsaUpdateAccessControl", - "GsaUpdateAccessControlCategory", - "GsaUpdateAccessControlCategoryTableMapping", "GsaUpdateAllProfilesInfo", "GsaUpdateAttribute", - "GsaUpdateAttributeBasedAccessControl", "GsaUpdateAxisName", "GsaUpdateConfiguration", "GsaUpdateConstant", "GsaUpdateContinuousRange", "GsaUpdateCrossDatabaseRecordLinkGroup", - "GsaUpdateCurrentRuleEngine", "GsaUpdateDataRule", "GsaUpdateDatabase", - "GsaUpdateDatabaseSecurityGroups", "GsaUpdateDateTimeAttribute", - "GsaUpdateDefaultDatabase", - "GsaUpdateDefaultFallbackSecurityGroups", "GsaUpdateDefaultProfile", "GsaUpdateDiscreteAttribute", "GsaUpdateDiscreteFunctionalAttribute", @@ -2934,8 +1974,7 @@ "GsaUpdateDiscreteParameterValue", "GsaUpdateDiscreteRange", "GsaUpdateDiscreteType", - "GsaUpdateDisplayNames", - "GsaUpdateDisplayNamesResponse", + "GsaUpdateDynamicRecordLinkGroup", "GsaUpdateExpression", "GsaUpdateFile", "GsaUpdateFileAttribute", @@ -2948,7 +1987,6 @@ "GsaUpdateIntegerAttribute", "GsaUpdateJobRequest", "GsaUpdateLayout", - "GsaUpdateLayoutSection", "GsaUpdateLinkedAttributeTabularColumn", "GsaUpdateLinkedColumnTabularColumn", "GsaUpdateLinkedRecordTabularColumn", @@ -2973,28 +2011,16 @@ "GsaUpdateParameter", "GsaUpdateParameterContent", "GsaUpdateParameterValue", - "GsaUpdatePermission", - "GsaUpdatePermissionAccessControl", - "GsaUpdatePermissionBasedAccessControl", - "GsaUpdatePermissionCategory", - "GsaUpdatePermissionCategoryAccessControl", - "GsaUpdatePermissionCategoryAccessControlRequest", "GsaUpdatePictureAttribute", "GsaUpdatePointAttribute", "GsaUpdateProfile", "GsaUpdateProfileTable", - "GsaUpdatePutLayoutItem", - "GsaUpdatePutPermission", - "GsaUpdatePutPermissionCategory", "GsaUpdateRangeAttribute", "GsaUpdateRecordLinkGroup", "GsaUpdateRecordListPermissionFlags", "GsaUpdateRecordListProperties", "GsaUpdateReplacementString", - "GsaUpdateRootFolderErrorDetail", - "GsaUpdateRunStatus", "GsaUpdateShortTextAttribute", - "GsaUpdateSmartRecordLinkGroup", "GsaUpdateStandardName", "GsaUpdateStaticRecordLinkGroup", "GsaUpdateSubset", @@ -3007,16 +2033,12 @@ "GsaUpdateUnitSystem", "GsaUpdateUserPermission", "GsaUpdateUserPermissionsInfo", - "GsaUpgradeDatabaseException", - "GsaUpgradeDatabaseFailureReason", "GsaUsageDataModificationErrorDetail", + "GsaUserOrGroup", "GsaUserPermission", "GsaUserPermissionsInfo", "GsaUserRole", "GsaValidateAttributeRequest", - "GsaValidateUnitEquationRequest", - "GsaValidateUnitEquationResponse", - "GsaValueNotProvidedParameterValueErrorDetail", "GsaValueSpecifier", "GsaValueSpecifierType", "GsaValueWithCountOfBoolean", @@ -3027,12 +2049,8 @@ "GsaVersionNumberProperty", "GsaVersionState", "GsaVersionStateProperty", - "GsaWeightingType", "GsaWithdrawRecordVersionControlException", - "GsaXYChartTemplate", "GsaXYChartTemplateUsageDataModificationErrorDetail", - "GsaXYChartTemplatesInfo", - "GsaXYTemplateAxis", "JobqueueFilesBody", "JsonPatchDocument", "MicrosoftAspNetCoreMvcFormattersIOutputFormatter", diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/granta_mi_search_free_text_identifiers.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/granta_mi_search_free_text_identifiers.py deleted file mode 100644 index 3c293edda..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/granta_mi_search_free_text_identifiers.py +++ /dev/null @@ -1,171 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GrantaMISearchFreeTextIdentifiers(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guids": "list[str]", - "column_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guids": "attributeGuids", - "column_guids": "columnGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guids: "list[str] | None | Unset_Type" = Unset, - column_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GrantaMISearchFreeTextIdentifiers - a model defined in Swagger - - Parameters - ---------- - attribute_guids: list[str] | None, optional - column_guids: list[str] | None, optional - """ - self._attribute_guids: list[str] | None | Unset_Type = Unset - self._column_guids: list[str] | None | Unset_Type = Unset - - if attribute_guids is not Unset: - self.attribute_guids = attribute_guids - if column_guids is not Unset: - self.column_guids = column_guids - - @property - def attribute_guids(self) -> "list[str] | None | Unset_Type": - """Gets the attribute_guids of this GrantaMISearchFreeTextIdentifiers. - - Returns - ------- - list[str] | None | Unset_Type - The attribute_guids of this GrantaMISearchFreeTextIdentifiers. - """ - return self._attribute_guids - - @attribute_guids.setter - def attribute_guids(self, attribute_guids: "list[str] | None | Unset_Type") -> None: - """Sets the attribute_guids of this GrantaMISearchFreeTextIdentifiers. - - Parameters - ---------- - attribute_guids: list[str] | None | Unset_Type - The attribute_guids of this GrantaMISearchFreeTextIdentifiers. - """ - self._attribute_guids = attribute_guids - - @property - def column_guids(self) -> "list[str] | None | Unset_Type": - """Gets the column_guids of this GrantaMISearchFreeTextIdentifiers. - - Returns - ------- - list[str] | None | Unset_Type - The column_guids of this GrantaMISearchFreeTextIdentifiers. - """ - return self._column_guids - - @column_guids.setter - def column_guids(self, column_guids: "list[str] | None | Unset_Type") -> None: - """Sets the column_guids of this GrantaMISearchFreeTextIdentifiers. - - Parameters - ---------- - column_guids: list[str] | None | Unset_Type - The column_guids of this GrantaMISearchFreeTextIdentifiers. - """ - self._column_guids = column_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GrantaMISearchFreeTextIdentifiers): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_categories_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_categories_info.py deleted file mode 100644 index 59966f6fe..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_categories_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoriesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "categories": "list[GsaAccessControlCategory]", - } - - attribute_map: dict[str, str] = { - "categories": "categories", - } - - subtype_mapping: dict[str, str] = { - "categories": "GsaAccessControlCategory", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - categories: "list[GsaAccessControlCategory]", - ) -> None: - """GsaAccessControlCategoriesInfo - a model defined in Swagger - - Parameters - ---------- - categories: list[GsaAccessControlCategory] - """ - self._categories: list[GsaAccessControlCategory] - - self.categories = categories - - @property - def categories(self) -> "list[GsaAccessControlCategory]": - """Gets the categories of this GsaAccessControlCategoriesInfo. - - Returns - ------- - list[GsaAccessControlCategory] - The categories of this GsaAccessControlCategoriesInfo. - """ - return self._categories - - @categories.setter - def categories(self, categories: "list[GsaAccessControlCategory]") -> None: - """Sets the categories of this GsaAccessControlCategoriesInfo. - - Parameters - ---------- - categories: list[GsaAccessControlCategory] - The categories of this GsaAccessControlCategoriesInfo. - """ - # Field is not nullable - if categories is None: - raise ValueError("Invalid value for 'categories', must not be 'None'") - # Field is required - if categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'categories', must not be 'Unset'") - self._categories = categories - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoriesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category.py deleted file mode 100644 index c0eb174fb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category.py +++ /dev/null @@ -1,251 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type": "GsaSlimEntity", - "guid": "str", - "name": "str", - "table_mappings": "list[GsaAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "discrete_type": "discreteType", - "guid": "guid", - "name": "name", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "discreteType": "GsaSlimEntity", - "tableMappings": "GsaAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type: "GsaSlimEntity", - guid: "str", - name: "str", - table_mappings: "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - discrete_type: GsaSlimEntity - guid: str - name: str - table_mappings: list[GsaAccessControlCategoryTableMapping] | None, optional - """ - self._discrete_type: GsaSlimEntity - self._table_mappings: list[GsaAccessControlCategoryTableMapping] | None | Unset_Type = Unset - self._name: str - self._guid: str - - self.discrete_type = discrete_type - if table_mappings is not Unset: - self.table_mappings = table_mappings - self.name = name - self.guid = guid - - @property - def discrete_type(self) -> "GsaSlimEntity": - """Gets the discrete_type of this GsaAccessControlCategory. - - Returns - ------- - GsaSlimEntity - The discrete_type of this GsaAccessControlCategory. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaSlimEntity") -> None: - """Sets the discrete_type of this GsaAccessControlCategory. - - Parameters - ---------- - discrete_type: GsaSlimEntity - The discrete_type of this GsaAccessControlCategory. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - # Field is required - if discrete_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type', must not be 'Unset'") - self._discrete_type = discrete_type - - @property - def table_mappings(self) -> "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type": - """Gets the table_mappings of this GsaAccessControlCategory. - Information specific to each table. - - Returns - ------- - list[GsaAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaAccessControlCategoryTableMapping] | None | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaAccessControlCategory. - Information specific to each table. - - Parameters - ---------- - table_mappings: list[GsaAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaAccessControlCategory. - """ - self._table_mappings = table_mappings - - @property - def name(self) -> "str": - """Gets the name of this GsaAccessControlCategory. - - Returns - ------- - str - The name of this GsaAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaAccessControlCategory. - - Parameters - ---------- - name: str - The name of this GsaAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaAccessControlCategory. - - Returns - ------- - str - The guid of this GsaAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaAccessControlCategory. - - Parameters - ---------- - guid: str - The guid of this GsaAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_creation_exception.py deleted file mode 100644 index 612d68eca..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_creation_exception.py +++ /dev/null @@ -1,242 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaAccessControlCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaAccessControlCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaAccessControlCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaAccessControlCategoryCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaAccessControlCategoryCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaAccessControlCategoryCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaAccessControlCategoryCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaAccessControlCategoryCreationException. - - Returns - ------- - str - The name of this GsaAccessControlCategoryCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - name: str - The name of this GsaAccessControlCategoryCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaAccessControlCategoryCreationException. - - Returns - ------- - list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryCreationException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaAccessControlCategoryCreationException. - - Parameters - ---------- - errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_detail.py deleted file mode 100644 index b3347dc62..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_detail.py +++ /dev/null @@ -1,201 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaAccessControlCategoryErrorReason", - } - - discriminator_value_class_map = { - "noSuchEntity".lower(): "#/components/schemas/GsaNoSuchEntityAccessControlCategoryErrorDetail", - "discreteValueNotInDiscreteType".lower(): "#/components/schemas/GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "attributeNotOnTable".lower(): "#/components/schemas/GsaAttributeNotOnTableErrorDetail", - "attributeDiscreteTypeMismatch".lower(): "#/components/schemas/GsaAttributeDiscreteTypeMismatchErrorDetail", - "multipleDefaultValuesInSingleValuedDiscrete".lower(): "#/components/schemas/GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityAccessControlCategoryErrorDetail", - "duplicateTable".lower(): "#/components/schemas/GsaDuplicateTableErrorDetail", - "duplicateDiscreteValue".lower(): "#/components/schemas/GsaDuplicateDiscreteValueErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason", - ) -> None: - """GsaAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - """ - self._message: str - self._reason: GsaAccessControlCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaAccessControlCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaAccessControlCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaAccessControlCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaAccessControlCategoryErrorReason": - """Gets the reason of this GsaAccessControlCategoryErrorDetail. - - Returns - ------- - GsaAccessControlCategoryErrorReason - The reason of this GsaAccessControlCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaAccessControlCategoryErrorReason") -> None: - """Sets the reason of this GsaAccessControlCategoryErrorDetail. - - Parameters - ---------- - reason: GsaAccessControlCategoryErrorReason - The reason of this GsaAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_reason.py deleted file mode 100644 index aa1090691..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_error_reason.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHENTITY = "noSuchEntity" - DISCRETEVALUENOTINDISCRETETYPE = "discreteValueNotInDiscreteType" - ATTRIBUTENOTONTABLE = "attributeNotOnTable" - ATTRIBUTEDISCRETETYPEMISMATCH = "attributeDiscreteTypeMismatch" - MULTIPLEDEFAULTVALUESINSINGLEVALUEDDISCRETE = "multipleDefaultValuesInSingleValuedDiscrete" - NAMEDENTITY = "namedEntity" - DUPLICATETABLE = "duplicateTable" - DUPLICATEDISCRETEVALUE = "duplicateDiscreteValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_include.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_include.py deleted file mode 100644 index f7e981bad..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_include.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryInclude(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - TABLEMAPPINGS = "tableMappings" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_no_such_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_no_such_entity_type.py deleted file mode 100644 index 80b0b7796..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_no_such_entity_type.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlCategoryNoSuchEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - TABLE = "table" - ATTRIBUTE = "attribute" - DISCRETETYPE = "discreteType" - DISCRETEVALUE = "discreteValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_table_mapping.py deleted file mode 100644 index 6e5c47c34..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_table_mapping.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "table": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "table": "table", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - table: "GsaSlimEntity", - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - table: GsaSlimEntity - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_update_exception.py deleted file mode 100644 index 302ac578a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_category_update_exception.py +++ /dev/null @@ -1,242 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlCategoryUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaAccessControlCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaAccessControlCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaAccessControlCategoryUpdateException - a model defined in Swagger - - Parameters - ---------- - category_guid: str - code: GsaErrorCode, optional - errors: list[GsaAccessControlCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._category_guid: str - self._errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.category_guid = category_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaAccessControlCategoryUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaAccessControlCategoryUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaAccessControlCategoryUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - str - The category_guid of this GsaAccessControlCategoryUpdateException. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaAccessControlCategoryUpdateException. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @property - def errors(self) -> "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaAccessControlCategoryUpdateException. - - Returns - ------- - list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryUpdateException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaAccessControlCategoryUpdateException. - - Parameters - ---------- - errors: list[GsaAccessControlCategoryErrorDetail] | None | Unset_Type - The errors of this GsaAccessControlCategoryUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlCategoryUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_info.py deleted file mode 100644 index 4c78e82b1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_info.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - discriminator_value_class_map = { - "permissionBased".lower(): "#/components/schemas/GsaPermissionBasedAccessControlInfo", - "attributeBased".lower(): "#/components/schemas/GsaAttributeBasedAccessControlInfo", - } - - discriminator: Optional[str] = "mode" - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - ) -> None: - """GsaAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - self._mode: GsaAccessControlMode - - self.mode = mode - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaAccessControlInfo. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaAccessControlInfo. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaAccessControlInfo. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaAccessControlInfo. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode.py deleted file mode 100644 index 198fd7b79..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaAccessControlMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - PERMISSIONBASED = "permissionBased" - ATTRIBUTEBASED = "attributeBased" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode_info.py deleted file mode 100644 index e0aacd1c9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_access_control_mode_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAccessControlModeInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - ) -> None: - """GsaAccessControlModeInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - self._mode: GsaAccessControlMode - - self.mode = mode - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaAccessControlModeInfo. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaAccessControlModeInfo. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaAccessControlModeInfo. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaAccessControlModeInfo. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAccessControlModeInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_name_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_name_filter.py deleted file mode 100644 index 16f4775a8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_name_filter.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogApplicationNameFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_name_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "application_name_to_match": "applicationNameToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_name_to_match: "str", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogApplicationNameFilter - a model defined in Swagger - - Parameters - ---------- - application_name_to_match: str - match_type: GsaActivityLogMatchType, optional - """ - self._application_name_to_match: str - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.application_name_to_match = application_name_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def application_name_to_match(self) -> "str": - """Gets the application_name_to_match of this GsaActivityLogApplicationNameFilter. - - Returns - ------- - str - The application_name_to_match of this GsaActivityLogApplicationNameFilter. - """ - return self._application_name_to_match - - @application_name_to_match.setter - def application_name_to_match(self, application_name_to_match: "str") -> None: - """Sets the application_name_to_match of this GsaActivityLogApplicationNameFilter. - - Parameters - ---------- - application_name_to_match: str - The application_name_to_match of this GsaActivityLogApplicationNameFilter. - """ - # Field is not nullable - if application_name_to_match is None: - raise ValueError("Invalid value for 'application_name_to_match', must not be 'None'") - # Field is required - if application_name_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_name_to_match', must not be 'Unset'") - self._application_name_to_match = application_name_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogApplicationNameFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogApplicationNameFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogApplicationNameFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogApplicationNameFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogApplicationNameFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_names_collection_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_names_collection_filter.py deleted file mode 100644 index f7904d6e9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_application_names_collection_filter.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogApplicationNamesCollectionFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_names_to_match": "list[str]", - "collection_match_type": "GsaActivityLogCollectionMatchType", - } - - attribute_map: dict[str, str] = { - "application_names_to_match": "applicationNamesToMatch", - "collection_match_type": "collectionMatchType", - } - - subtype_mapping: dict[str, str] = { - "collectionMatchType": "GsaActivityLogCollectionMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_names_to_match: "list[str]", - collection_match_type: "GsaActivityLogCollectionMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogApplicationNamesCollectionFilter - a model defined in Swagger - - Parameters - ---------- - application_names_to_match: list[str] - collection_match_type: GsaActivityLogCollectionMatchType, optional - """ - self._application_names_to_match: list[str] - self._collection_match_type: GsaActivityLogCollectionMatchType | Unset_Type = Unset - - self.application_names_to_match = application_names_to_match - if collection_match_type is not Unset: - self.collection_match_type = collection_match_type - - @property - def application_names_to_match(self) -> "list[str]": - """Gets the application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - - Returns - ------- - list[str] - The application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - """ - return self._application_names_to_match - - @application_names_to_match.setter - def application_names_to_match(self, application_names_to_match: "list[str]") -> None: - """Sets the application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - - Parameters - ---------- - application_names_to_match: list[str] - The application_names_to_match of this GsaActivityLogApplicationNamesCollectionFilter. - """ - # Field is not nullable - if application_names_to_match is None: - raise ValueError("Invalid value for 'application_names_to_match', must not be 'None'") - # Field is required - if application_names_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_names_to_match', must not be 'Unset'") - self._application_names_to_match = application_names_to_match - - @property - def collection_match_type(self) -> "GsaActivityLogCollectionMatchType | Unset_Type": - """Gets the collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - - Returns - ------- - GsaActivityLogCollectionMatchType | Unset_Type - The collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - """ - return self._collection_match_type - - @collection_match_type.setter - def collection_match_type( - self, collection_match_type: "GsaActivityLogCollectionMatchType | Unset_Type" - ) -> None: - """Sets the collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - - Parameters - ---------- - collection_match_type: GsaActivityLogCollectionMatchType | Unset_Type - The collection_match_type of this GsaActivityLogApplicationNamesCollectionFilter. - """ - # Field is not nullable - if collection_match_type is None: - raise ValueError("Invalid value for 'collection_match_type', must not be 'None'") - self._collection_match_type = collection_match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogApplicationNamesCollectionFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_collection_match_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_collection_match_type.py deleted file mode 100644 index bd08738c8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_collection_match_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogCollectionMatchType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - COLLECTIONEXACTMATCH = "collectionExactMatch" - COLLECTIONCONTAINS = "collectionContains" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_database_key_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_database_key_filter.py deleted file mode 100644 index 256a5c547..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_database_key_filter.py +++ /dev/null @@ -1,178 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogDatabaseKeyFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "database_key_to_match": "databaseKeyToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key_to_match: "str | None", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogDatabaseKeyFilter - a model defined in Swagger - - Parameters - ---------- - database_key_to_match: str | None - match_type: GsaActivityLogMatchType, optional - """ - self._database_key_to_match: str | None - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.database_key_to_match = database_key_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def database_key_to_match(self) -> "str | None": - """Gets the database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - - Returns - ------- - str | None - The database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - """ - return self._database_key_to_match - - @database_key_to_match.setter - def database_key_to_match(self, database_key_to_match: "str | None") -> None: - """Sets the database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - - Parameters - ---------- - database_key_to_match: str | None - The database_key_to_match of this GsaActivityLogDatabaseKeyFilter. - """ - # Field is required - if database_key_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key_to_match', must not be 'Unset'") - self._database_key_to_match = database_key_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogDatabaseKeyFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogDatabaseKeyFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogDatabaseKeyFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogDatabaseKeyFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogDatabaseKeyFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_date_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_date_filter.py deleted file mode 100644 index 351b9e4a7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_date_filter.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogDateFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "date_from": "datetime", - "date_from_inclusive": "bool", - "date_to": "datetime", - "date_to_inclusive": "bool", - } - - attribute_map: dict[str, str] = { - "date_from": "dateFrom", - "date_from_inclusive": "dateFromInclusive", - "date_to": "dateTo", - "date_to_inclusive": "dateToInclusive", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - date_from: "datetime | None | Unset_Type" = Unset, - date_from_inclusive: "bool | Unset_Type" = Unset, - date_to: "datetime | None | Unset_Type" = Unset, - date_to_inclusive: "bool | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogDateFilter - a model defined in Swagger - - Parameters - ---------- - date_from: datetime | None, optional - date_from_inclusive: bool, optional - date_to: datetime | None, optional - date_to_inclusive: bool, optional - """ - self._date_from: datetime | None | Unset_Type = Unset - self._date_from_inclusive: bool | Unset_Type = Unset - self._date_to: datetime | None | Unset_Type = Unset - self._date_to_inclusive: bool | Unset_Type = Unset - - if date_from is not Unset: - self.date_from = date_from - if date_from_inclusive is not Unset: - self.date_from_inclusive = date_from_inclusive - if date_to is not Unset: - self.date_to = date_to - if date_to_inclusive is not Unset: - self.date_to_inclusive = date_to_inclusive - - @property - def date_from(self) -> "datetime | None | Unset_Type": - """Gets the date_from of this GsaActivityLogDateFilter. - - Returns - ------- - datetime | None | Unset_Type - The date_from of this GsaActivityLogDateFilter. - """ - return self._date_from - - @date_from.setter - def date_from(self, date_from: "datetime | None | Unset_Type") -> None: - """Sets the date_from of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_from: datetime | None | Unset_Type - The date_from of this GsaActivityLogDateFilter. - """ - self._date_from = date_from - - @property - def date_from_inclusive(self) -> "bool | Unset_Type": - """Gets the date_from_inclusive of this GsaActivityLogDateFilter. - - Returns - ------- - bool | Unset_Type - The date_from_inclusive of this GsaActivityLogDateFilter. - """ - return self._date_from_inclusive - - @date_from_inclusive.setter - def date_from_inclusive(self, date_from_inclusive: "bool | Unset_Type") -> None: - """Sets the date_from_inclusive of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_from_inclusive: bool | Unset_Type - The date_from_inclusive of this GsaActivityLogDateFilter. - """ - # Field is not nullable - if date_from_inclusive is None: - raise ValueError("Invalid value for 'date_from_inclusive', must not be 'None'") - self._date_from_inclusive = date_from_inclusive - - @property - def date_to(self) -> "datetime | None | Unset_Type": - """Gets the date_to of this GsaActivityLogDateFilter. - - Returns - ------- - datetime | None | Unset_Type - The date_to of this GsaActivityLogDateFilter. - """ - return self._date_to - - @date_to.setter - def date_to(self, date_to: "datetime | None | Unset_Type") -> None: - """Sets the date_to of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_to: datetime | None | Unset_Type - The date_to of this GsaActivityLogDateFilter. - """ - self._date_to = date_to - - @property - def date_to_inclusive(self) -> "bool | Unset_Type": - """Gets the date_to_inclusive of this GsaActivityLogDateFilter. - - Returns - ------- - bool | Unset_Type - The date_to_inclusive of this GsaActivityLogDateFilter. - """ - return self._date_to_inclusive - - @date_to_inclusive.setter - def date_to_inclusive(self, date_to_inclusive: "bool | Unset_Type") -> None: - """Sets the date_to_inclusive of this GsaActivityLogDateFilter. - - Parameters - ---------- - date_to_inclusive: bool | Unset_Type - The date_to_inclusive of this GsaActivityLogDateFilter. - """ - # Field is not nullable - if date_to_inclusive is None: - raise ValueError("Invalid value for 'date_to_inclusive', must not be 'None'") - self._date_to_inclusive = date_to_inclusive - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogDateFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_filter.py deleted file mode 100644 index 8a00b054e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_filter.py +++ /dev/null @@ -1,327 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntriesFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "application_name_filter": "GsaActivityLogApplicationNameFilter", - "application_names_collection_filter": "GsaActivityLogApplicationNamesCollectionFilter", - "database_key_filter": "GsaActivityLogDatabaseKeyFilter", - "date_filter": "GsaActivityLogDateFilter", - "usage_mode_filter": "GsaActivityLogUsageModeFilter", - "username_filter": "GsaActivityLogUsernameFilter", - } - - attribute_map: dict[str, str] = { - "application_name_filter": "applicationNameFilter", - "application_names_collection_filter": "applicationNamesCollectionFilter", - "database_key_filter": "databaseKeyFilter", - "date_filter": "dateFilter", - "usage_mode_filter": "usageModeFilter", - "username_filter": "usernameFilter", - } - - subtype_mapping: dict[str, str] = { - "dateFilter": "GsaActivityLogDateFilter", - "usernameFilter": "GsaActivityLogUsernameFilter", - "applicationNamesCollectionFilter": "GsaActivityLogApplicationNamesCollectionFilter", - "applicationNameFilter": "GsaActivityLogApplicationNameFilter", - "databaseKeyFilter": "GsaActivityLogDatabaseKeyFilter", - "usageModeFilter": "GsaActivityLogUsageModeFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - application_name_filter: "GsaActivityLogApplicationNameFilter | Unset_Type" = Unset, - application_names_collection_filter: "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type" = Unset, - database_key_filter: "GsaActivityLogDatabaseKeyFilter | Unset_Type" = Unset, - date_filter: "GsaActivityLogDateFilter | Unset_Type" = Unset, - usage_mode_filter: "GsaActivityLogUsageModeFilter | Unset_Type" = Unset, - username_filter: "GsaActivityLogUsernameFilter | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogEntriesFilter - a model defined in Swagger - - Parameters - ---------- - application_name_filter: GsaActivityLogApplicationNameFilter, optional - application_names_collection_filter: GsaActivityLogApplicationNamesCollectionFilter, optional - database_key_filter: GsaActivityLogDatabaseKeyFilter, optional - date_filter: GsaActivityLogDateFilter, optional - usage_mode_filter: GsaActivityLogUsageModeFilter, optional - username_filter: GsaActivityLogUsernameFilter, optional - """ - self._date_filter: GsaActivityLogDateFilter | Unset_Type = Unset - self._username_filter: GsaActivityLogUsernameFilter | Unset_Type = Unset - self._application_names_collection_filter: ( - GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - ) = Unset - self._application_name_filter: GsaActivityLogApplicationNameFilter | Unset_Type = Unset - self._database_key_filter: GsaActivityLogDatabaseKeyFilter | Unset_Type = Unset - self._usage_mode_filter: GsaActivityLogUsageModeFilter | Unset_Type = Unset - - if date_filter is not Unset: - self.date_filter = date_filter - if username_filter is not Unset: - self.username_filter = username_filter - if application_names_collection_filter is not Unset: - self.application_names_collection_filter = application_names_collection_filter - if application_name_filter is not Unset: - self.application_name_filter = application_name_filter - if database_key_filter is not Unset: - self.database_key_filter = database_key_filter - if usage_mode_filter is not Unset: - self.usage_mode_filter = usage_mode_filter - - @property - def date_filter(self) -> "GsaActivityLogDateFilter | Unset_Type": - """Gets the date_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogDateFilter | Unset_Type - The date_filter of this GsaActivityLogEntriesFilter. - """ - return self._date_filter - - @date_filter.setter - def date_filter(self, date_filter: "GsaActivityLogDateFilter | Unset_Type") -> None: - """Sets the date_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - date_filter: GsaActivityLogDateFilter | Unset_Type - The date_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if date_filter is None: - raise ValueError("Invalid value for 'date_filter', must not be 'None'") - self._date_filter = date_filter - - @property - def username_filter(self) -> "GsaActivityLogUsernameFilter | Unset_Type": - """Gets the username_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogUsernameFilter | Unset_Type - The username_filter of this GsaActivityLogEntriesFilter. - """ - return self._username_filter - - @username_filter.setter - def username_filter(self, username_filter: "GsaActivityLogUsernameFilter | Unset_Type") -> None: - """Sets the username_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - username_filter: GsaActivityLogUsernameFilter | Unset_Type - The username_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if username_filter is None: - raise ValueError("Invalid value for 'username_filter', must not be 'None'") - self._username_filter = username_filter - - @property - def application_names_collection_filter( - self, - ) -> "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type": - """Gets the application_names_collection_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - The application_names_collection_filter of this GsaActivityLogEntriesFilter. - """ - return self._application_names_collection_filter - - @application_names_collection_filter.setter - def application_names_collection_filter( - self, - application_names_collection_filter: "GsaActivityLogApplicationNamesCollectionFilter | Unset_Type", - ) -> None: - """Sets the application_names_collection_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - application_names_collection_filter: GsaActivityLogApplicationNamesCollectionFilter | Unset_Type - The application_names_collection_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if application_names_collection_filter is None: - raise ValueError( - "Invalid value for 'application_names_collection_filter', must not be 'None'" - ) - self._application_names_collection_filter = application_names_collection_filter - - @property - def application_name_filter(self) -> "GsaActivityLogApplicationNameFilter | Unset_Type": - """Gets the application_name_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogApplicationNameFilter | Unset_Type - The application_name_filter of this GsaActivityLogEntriesFilter. - """ - return self._application_name_filter - - @application_name_filter.setter - def application_name_filter( - self, application_name_filter: "GsaActivityLogApplicationNameFilter | Unset_Type" - ) -> None: - """Sets the application_name_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - application_name_filter: GsaActivityLogApplicationNameFilter | Unset_Type - The application_name_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if application_name_filter is None: - raise ValueError("Invalid value for 'application_name_filter', must not be 'None'") - self._application_name_filter = application_name_filter - - @property - def database_key_filter(self) -> "GsaActivityLogDatabaseKeyFilter | Unset_Type": - """Gets the database_key_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogDatabaseKeyFilter | Unset_Type - The database_key_filter of this GsaActivityLogEntriesFilter. - """ - return self._database_key_filter - - @database_key_filter.setter - def database_key_filter( - self, database_key_filter: "GsaActivityLogDatabaseKeyFilter | Unset_Type" - ) -> None: - """Sets the database_key_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - database_key_filter: GsaActivityLogDatabaseKeyFilter | Unset_Type - The database_key_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if database_key_filter is None: - raise ValueError("Invalid value for 'database_key_filter', must not be 'None'") - self._database_key_filter = database_key_filter - - @property - def usage_mode_filter(self) -> "GsaActivityLogUsageModeFilter | Unset_Type": - """Gets the usage_mode_filter of this GsaActivityLogEntriesFilter. - - Returns - ------- - GsaActivityLogUsageModeFilter | Unset_Type - The usage_mode_filter of this GsaActivityLogEntriesFilter. - """ - return self._usage_mode_filter - - @usage_mode_filter.setter - def usage_mode_filter( - self, usage_mode_filter: "GsaActivityLogUsageModeFilter | Unset_Type" - ) -> None: - """Sets the usage_mode_filter of this GsaActivityLogEntriesFilter. - - Parameters - ---------- - usage_mode_filter: GsaActivityLogUsageModeFilter | Unset_Type - The usage_mode_filter of this GsaActivityLogEntriesFilter. - """ - # Field is not nullable - if usage_mode_filter is None: - raise ValueError("Invalid value for 'usage_mode_filter', must not be 'None'") - self._usage_mode_filter = usage_mode_filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntriesFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_info.py deleted file mode 100644 index 2db9b4168..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entries_info.py +++ /dev/null @@ -1,219 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntriesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaActivityLogEntry]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaActivityLogEntry", - "links": "GsaPaginationLinks", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entries: "list[GsaActivityLogEntry]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaActivityLogEntriesInfo - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaActivityLogEntry] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaActivityLogEntry] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaActivityLogEntriesInfo. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaActivityLogEntriesInfo. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaActivityLogEntry]": - """Gets the entries of this GsaActivityLogEntriesInfo. - - Returns - ------- - list[GsaActivityLogEntry] - The entries of this GsaActivityLogEntriesInfo. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaActivityLogEntry]") -> None: - """Sets the entries of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - entries: list[GsaActivityLogEntry] - The entries of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaActivityLogEntriesInfo. - - Returns - ------- - GsaPaginationLinks - The links of this GsaActivityLogEntriesInfo. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaActivityLogEntriesInfo. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaActivityLogEntriesInfo. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntriesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entry.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entry.py deleted file mode 100644 index 96c6364f2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_entry.py +++ /dev/null @@ -1,280 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogEntry(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "_date": "datetime", - "application_names": "list[str]", - "usage_mode": "GsaActivityLogUsageMode", - "username": "str", - "database_key": "str", - } - - attribute_map: dict[str, str] = { - "_date": "date", - "application_names": "applicationNames", - "usage_mode": "usageMode", - "username": "username", - "database_key": "databaseKey", - } - - subtype_mapping: dict[str, str] = { - "usageMode": "GsaActivityLogUsageMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - _date: "datetime", - application_names: "list[str]", - usage_mode: "GsaActivityLogUsageMode", - username: "str", - database_key: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogEntry - a model defined in Swagger - - Parameters - ---------- - _date: datetime - application_names: list[str] - usage_mode: GsaActivityLogUsageMode - username: str - database_key: str | None, optional - """ - self.__date: datetime - self._username: str - self._application_names: list[str] - self._database_key: str | None | Unset_Type = Unset - self._usage_mode: GsaActivityLogUsageMode - - self._date = _date - self.username = username - self.application_names = application_names - if database_key is not Unset: - self.database_key = database_key - self.usage_mode = usage_mode - - @property - def _date(self) -> "datetime": - """Gets the _date of this GsaActivityLogEntry. - - Returns - ------- - datetime - The _date of this GsaActivityLogEntry. - """ - return self.__date - - @_date.setter - def _date(self, _date: "datetime") -> None: - """Sets the _date of this GsaActivityLogEntry. - - Parameters - ---------- - _date: datetime - The _date of this GsaActivityLogEntry. - """ - # Field is not nullable - if _date is None: - raise ValueError("Invalid value for '_date', must not be 'None'") - # Field is required - if _date is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for '_date', must not be 'Unset'") - self.__date = _date - - @property - def username(self) -> "str": - """Gets the username of this GsaActivityLogEntry. - - Returns - ------- - str - The username of this GsaActivityLogEntry. - """ - return self._username - - @username.setter - def username(self, username: "str") -> None: - """Sets the username of this GsaActivityLogEntry. - - Parameters - ---------- - username: str - The username of this GsaActivityLogEntry. - """ - # Field is not nullable - if username is None: - raise ValueError("Invalid value for 'username', must not be 'None'") - # Field is required - if username is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username', must not be 'Unset'") - self._username = username - - @property - def application_names(self) -> "list[str]": - """Gets the application_names of this GsaActivityLogEntry. - - Returns - ------- - list[str] - The application_names of this GsaActivityLogEntry. - """ - return self._application_names - - @application_names.setter - def application_names(self, application_names: "list[str]") -> None: - """Sets the application_names of this GsaActivityLogEntry. - - Parameters - ---------- - application_names: list[str] - The application_names of this GsaActivityLogEntry. - """ - # Field is not nullable - if application_names is None: - raise ValueError("Invalid value for 'application_names', must not be 'None'") - # Field is required - if application_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'application_names', must not be 'Unset'") - self._application_names = application_names - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaActivityLogEntry. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaActivityLogEntry. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaActivityLogEntry. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaActivityLogEntry. - """ - self._database_key = database_key - - @property - def usage_mode(self) -> "GsaActivityLogUsageMode": - """Gets the usage_mode of this GsaActivityLogEntry. - - Returns - ------- - GsaActivityLogUsageMode - The usage_mode of this GsaActivityLogEntry. - """ - return self._usage_mode - - @usage_mode.setter - def usage_mode(self, usage_mode: "GsaActivityLogUsageMode") -> None: - """Sets the usage_mode of this GsaActivityLogEntry. - - Parameters - ---------- - usage_mode: GsaActivityLogUsageMode - The usage_mode of this GsaActivityLogEntry. - """ - # Field is not nullable - if usage_mode is None: - raise ValueError("Invalid value for 'usage_mode', must not be 'None'") - # Field is required - if usage_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'usage_mode', must not be 'Unset'") - self._usage_mode = usage_mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogEntry): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_match_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_match_type.py deleted file mode 100644 index 08d5ff0bb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_match_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogMatchType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EXACTMATCHCASEINSENSITIVE = "exactMatchCaseInsensitive" - CONTAINSCASEINSENSITIVE = "containsCaseInsensitive" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode.py deleted file mode 100644 index 9e4b047ff..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaActivityLogUsageMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - VIEW = "view" - EDIT = "edit" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode_filter.py deleted file mode 100644 index 6848de406..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_usage_mode_filter.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogUsageModeFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "usage_mode_to_match": "GsaActivityLogUsageMode", - } - - attribute_map: dict[str, str] = { - "usage_mode_to_match": "usageModeToMatch", - } - - subtype_mapping: dict[str, str] = { - "usageModeToMatch": "GsaActivityLogUsageMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - usage_mode_to_match: "GsaActivityLogUsageMode", - ) -> None: - """GsaActivityLogUsageModeFilter - a model defined in Swagger - - Parameters - ---------- - usage_mode_to_match: GsaActivityLogUsageMode - """ - self._usage_mode_to_match: GsaActivityLogUsageMode - - self.usage_mode_to_match = usage_mode_to_match - - @property - def usage_mode_to_match(self) -> "GsaActivityLogUsageMode": - """Gets the usage_mode_to_match of this GsaActivityLogUsageModeFilter. - - Returns - ------- - GsaActivityLogUsageMode - The usage_mode_to_match of this GsaActivityLogUsageModeFilter. - """ - return self._usage_mode_to_match - - @usage_mode_to_match.setter - def usage_mode_to_match(self, usage_mode_to_match: "GsaActivityLogUsageMode") -> None: - """Sets the usage_mode_to_match of this GsaActivityLogUsageModeFilter. - - Parameters - ---------- - usage_mode_to_match: GsaActivityLogUsageMode - The usage_mode_to_match of this GsaActivityLogUsageModeFilter. - """ - # Field is not nullable - if usage_mode_to_match is None: - raise ValueError("Invalid value for 'usage_mode_to_match', must not be 'None'") - # Field is required - if usage_mode_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'usage_mode_to_match', must not be 'Unset'") - self._usage_mode_to_match = usage_mode_to_match - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogUsageModeFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_username_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_username_filter.py deleted file mode 100644 index b53d234d8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_activity_log_username_filter.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaActivityLogUsernameFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "username_to_match": "str", - "match_type": "GsaActivityLogMatchType", - } - - attribute_map: dict[str, str] = { - "username_to_match": "usernameToMatch", - "match_type": "matchType", - } - - subtype_mapping: dict[str, str] = { - "matchType": "GsaActivityLogMatchType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - username_to_match: "str", - match_type: "GsaActivityLogMatchType | Unset_Type" = Unset, - ) -> None: - """GsaActivityLogUsernameFilter - a model defined in Swagger - - Parameters - ---------- - username_to_match: str - match_type: GsaActivityLogMatchType, optional - """ - self._username_to_match: str - self._match_type: GsaActivityLogMatchType | Unset_Type = Unset - - self.username_to_match = username_to_match - if match_type is not Unset: - self.match_type = match_type - - @property - def username_to_match(self) -> "str": - """Gets the username_to_match of this GsaActivityLogUsernameFilter. - - Returns - ------- - str - The username_to_match of this GsaActivityLogUsernameFilter. - """ - return self._username_to_match - - @username_to_match.setter - def username_to_match(self, username_to_match: "str") -> None: - """Sets the username_to_match of this GsaActivityLogUsernameFilter. - - Parameters - ---------- - username_to_match: str - The username_to_match of this GsaActivityLogUsernameFilter. - """ - # Field is not nullable - if username_to_match is None: - raise ValueError("Invalid value for 'username_to_match', must not be 'None'") - # Field is required - if username_to_match is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username_to_match', must not be 'Unset'") - self._username_to_match = username_to_match - - @property - def match_type(self) -> "GsaActivityLogMatchType | Unset_Type": - """Gets the match_type of this GsaActivityLogUsernameFilter. - - Returns - ------- - GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogUsernameFilter. - """ - return self._match_type - - @match_type.setter - def match_type(self, match_type: "GsaActivityLogMatchType | Unset_Type") -> None: - """Sets the match_type of this GsaActivityLogUsernameFilter. - - Parameters - ---------- - match_type: GsaActivityLogMatchType | Unset_Type - The match_type of this GsaActivityLogUsernameFilter. - """ - # Field is not nullable - if match_type is None: - raise ValueError("Invalid value for 'match_type', must not be 'None'") - self._match_type = match_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaActivityLogUsernameFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database.py index 52b3182d2..e2574a897 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database.py @@ -61,8 +61,8 @@ class GsaAddDatabase(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "connection_details": "GsaConnectionDetails", "database_key": "str", - "input_connection_details": "GsaInputConnectionDetails", "is_read_only": "bool", "language": "str", "loading_order": "int", @@ -70,8 +70,8 @@ class GsaAddDatabase(ModelBase): } attribute_map: dict[str, str] = { + "connection_details": "connectionDetails", "database_key": "databaseKey", - "input_connection_details": "inputConnectionDetails", "is_read_only": "isReadOnly", "language": "language", "loading_order": "loadingOrder", @@ -79,7 +79,7 @@ class GsaAddDatabase(ModelBase): } subtype_mapping: dict[str, str] = { - "inputConnectionDetails": "GsaInputConnectionDetails", + "connectionDetails": "GsaConnectionDetails", } discriminator: Optional[str] = None @@ -87,8 +87,8 @@ class GsaAddDatabase(ModelBase): def __init__( self, *, + connection_details: "GsaConnectionDetails", database_key: "str", - input_connection_details: "GsaInputConnectionDetails", is_read_only: "bool | None | Unset_Type" = Unset, language: "str | None | Unset_Type" = Unset, loading_order: "int | None | Unset_Type" = Unset, @@ -98,22 +98,22 @@ def __init__( Parameters ---------- + connection_details: GsaConnectionDetails database_key: str - input_connection_details: GsaInputConnectionDetails is_read_only: bool | None, optional language: str | None, optional loading_order: int | None, optional version_guid: str | None, optional """ self._database_key: str - self._input_connection_details: GsaInputConnectionDetails + self._connection_details: GsaConnectionDetails self._is_read_only: bool | None | Unset_Type = Unset self._loading_order: int | None | Unset_Type = Unset self._language: str | None | Unset_Type = Unset self._version_guid: str | None | Unset_Type = Unset self.database_key = database_key - self.input_connection_details = input_connection_details + self.connection_details = connection_details if is_read_only is not Unset: self.is_read_only = is_read_only if loading_order is not Unset: @@ -152,34 +152,32 @@ def database_key(self, database_key: "str") -> None: self._database_key = database_key @property - def input_connection_details(self) -> "GsaInputConnectionDetails": - """Gets the input_connection_details of this GsaAddDatabase. + def connection_details(self) -> "GsaConnectionDetails": + """Gets the connection_details of this GsaAddDatabase. Returns ------- - GsaInputConnectionDetails - The input_connection_details of this GsaAddDatabase. + GsaConnectionDetails + The connection_details of this GsaAddDatabase. """ - return self._input_connection_details + return self._connection_details - @input_connection_details.setter - def input_connection_details( - self, input_connection_details: "GsaInputConnectionDetails" - ) -> None: - """Sets the input_connection_details of this GsaAddDatabase. + @connection_details.setter + def connection_details(self, connection_details: "GsaConnectionDetails") -> None: + """Sets the connection_details of this GsaAddDatabase. Parameters ---------- - input_connection_details: GsaInputConnectionDetails - The input_connection_details of this GsaAddDatabase. + connection_details: GsaConnectionDetails + The connection_details of this GsaAddDatabase. """ # Field is not nullable - if input_connection_details is None: - raise ValueError("Invalid value for 'input_connection_details', must not be 'None'") + if connection_details is None: + raise ValueError("Invalid value for 'connection_details', must not be 'None'") # Field is required - if input_connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'input_connection_details', must not be 'Unset'") - self._input_connection_details = input_connection_details + if connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'connection_details', must not be 'Unset'") + self._connection_details = connection_details @property def is_read_only(self) -> "bool | None | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database_security_groups.py deleted file mode 100644 index 59ac0c155..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_add_database_security_groups.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAddDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | None", - grant_group: "str | None", - power_user_group: "str | None", - read_group: "str | None", - write_group: "str | None", - ) -> None: - """GsaAddDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str | None - grant_group: str | None - power_user_group: str | None - read_group: str | None - write_group: str | None - """ - self._admin_group: str | None - self._grant_group: str | None - self._power_user_group: str | None - self._write_group: str | None - self._read_group: str | None - - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def admin_group(self) -> "str | None": - """Gets the admin_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The admin_group of this GsaAddDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | None") -> None: - """Sets the admin_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str | None - The admin_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | None": - """Gets the grant_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The grant_group of this GsaAddDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | None") -> None: - """Sets the grant_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str | None - The grant_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | None": - """Gets the power_user_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The power_user_group of this GsaAddDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | None") -> None: - """Sets the power_user_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str | None - The power_user_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | None": - """Gets the write_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The write_group of this GsaAddDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | None") -> None: - """Sets the write_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str | None - The write_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str | None": - """Gets the read_group of this GsaAddDatabaseSecurityGroups. - - Returns - ------- - str | None - The read_group of this GsaAddDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | None") -> None: - """Sets the read_group of this GsaAddDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str | None - The read_group of this GsaAddDatabaseSecurityGroups. - """ - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAddDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_aggregations_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_aggregations_request.py index c15d5a970..4c546836b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_aggregations_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_aggregations_request.py @@ -63,19 +63,16 @@ class GsaAggregationsRequest(ModelBase): swagger_types: dict[str, str] = { "aggregation_criteria": "list[GsaAggregationCriterion]", "criterion": "GsaCriterion", - "table_search_behaviour": "GsaTableSearchBehaviour", } attribute_map: dict[str, str] = { "aggregation_criteria": "aggregationCriteria", "criterion": "criterion", - "table_search_behaviour": "tableSearchBehaviour", } subtype_mapping: dict[str, str] = { "criterion": "GsaCriterion", "aggregationCriteria": "GsaAggregationCriterion", - "tableSearchBehaviour": "GsaTableSearchBehaviour", } discriminator: Optional[str] = None @@ -85,7 +82,6 @@ def __init__( *, aggregation_criteria: "list[GsaAggregationCriterion] | None | Unset_Type" = Unset, criterion: "GsaCriterion | Unset_Type" = Unset, - table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" = Unset, ) -> None: """GsaAggregationsRequest - a model defined in Swagger @@ -93,18 +89,14 @@ def __init__( ---------- aggregation_criteria: list[GsaAggregationCriterion] | None, optional criterion: GsaCriterion, optional - table_search_behaviour: GsaTableSearchBehaviour, optional """ self._criterion: GsaCriterion | Unset_Type = Unset self._aggregation_criteria: list[GsaAggregationCriterion] | None | Unset_Type = Unset - self._table_search_behaviour: GsaTableSearchBehaviour | Unset_Type = Unset if criterion is not Unset: self.criterion = criterion if aggregation_criteria is not Unset: self.aggregation_criteria = aggregation_criteria - if table_search_behaviour is not Unset: - self.table_search_behaviour = table_search_behaviour @property def criterion(self) -> "GsaCriterion | Unset_Type": @@ -157,33 +149,6 @@ def aggregation_criteria( """ self._aggregation_criteria = aggregation_criteria - @property - def table_search_behaviour(self) -> "GsaTableSearchBehaviour | Unset_Type": - """Gets the table_search_behaviour of this GsaAggregationsRequest. - - Returns - ------- - GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaAggregationsRequest. - """ - return self._table_search_behaviour - - @table_search_behaviour.setter - def table_search_behaviour( - self, table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" - ) -> None: - """Sets the table_search_behaviour of this GsaAggregationsRequest. - - Parameters - ---------- - table_search_behaviour: GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaAggregationsRequest. - """ - # Field is not nullable - if table_search_behaviour is None: - raise ValueError("Invalid value for 'table_search_behaviour', must not be 'None'") - self._table_search_behaviour = table_search_behaviour - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_apply_options.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_apply_options.py deleted file mode 100644 index c8dc13801..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_apply_options.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaApplyOptions(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_adds_as_state": "bool", - "match_mode": "GsaMatchMode", - "retarget_tabular_attributes": "bool", - } - - attribute_map: dict[str, str] = { - "apply_adds_as_state": "applyAddsAsState", - "match_mode": "matchMode", - "retarget_tabular_attributes": "retargetTabularAttributes", - } - - subtype_mapping: dict[str, str] = { - "matchMode": "GsaMatchMode", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_adds_as_state: "bool", - match_mode: "GsaMatchMode", - retarget_tabular_attributes: "bool", - ) -> None: - """GsaApplyOptions - a model defined in Swagger - - Parameters - ---------- - apply_adds_as_state: bool - match_mode: GsaMatchMode - retarget_tabular_attributes: bool - """ - self._match_mode: GsaMatchMode - self._apply_adds_as_state: bool - self._retarget_tabular_attributes: bool - - self.match_mode = match_mode - self.apply_adds_as_state = apply_adds_as_state - self.retarget_tabular_attributes = retarget_tabular_attributes - - @property - def match_mode(self) -> "GsaMatchMode": - """Gets the match_mode of this GsaApplyOptions. - - Returns - ------- - GsaMatchMode - The match_mode of this GsaApplyOptions. - """ - return self._match_mode - - @match_mode.setter - def match_mode(self, match_mode: "GsaMatchMode") -> None: - """Sets the match_mode of this GsaApplyOptions. - - Parameters - ---------- - match_mode: GsaMatchMode - The match_mode of this GsaApplyOptions. - """ - # Field is not nullable - if match_mode is None: - raise ValueError("Invalid value for 'match_mode', must not be 'None'") - # Field is required - if match_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'match_mode', must not be 'Unset'") - self._match_mode = match_mode - - @property - def apply_adds_as_state(self) -> "bool": - """Gets the apply_adds_as_state of this GsaApplyOptions. - - Returns - ------- - bool - The apply_adds_as_state of this GsaApplyOptions. - """ - return self._apply_adds_as_state - - @apply_adds_as_state.setter - def apply_adds_as_state(self, apply_adds_as_state: "bool") -> None: - """Sets the apply_adds_as_state of this GsaApplyOptions. - - Parameters - ---------- - apply_adds_as_state: bool - The apply_adds_as_state of this GsaApplyOptions. - """ - # Field is not nullable - if apply_adds_as_state is None: - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'None'") - # Field is required - if apply_adds_as_state is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'Unset'") - self._apply_adds_as_state = apply_adds_as_state - - @property - def retarget_tabular_attributes(self) -> "bool": - """Gets the retarget_tabular_attributes of this GsaApplyOptions. - - Returns - ------- - bool - The retarget_tabular_attributes of this GsaApplyOptions. - """ - return self._retarget_tabular_attributes - - @retarget_tabular_attributes.setter - def retarget_tabular_attributes(self, retarget_tabular_attributes: "bool") -> None: - """Sets the retarget_tabular_attributes of this GsaApplyOptions. - - Parameters - ---------- - retarget_tabular_attributes: bool - The retarget_tabular_attributes of this GsaApplyOptions. - """ - # Field is not nullable - if retarget_tabular_attributes is None: - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'None'") - # Field is required - if retarget_tabular_attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'Unset'") - self._retarget_tabular_attributes = retarget_tabular_attributes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaApplyOptions): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_association_chain_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_association_chain_create_put_layout_item.py deleted file mode 100644 index 0e55bc236..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_association_chain_create_put_layout_item.py +++ /dev/null @@ -1,202 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAssociationChainCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "association_chain_links": "list[GsaNewLayoutAssociationChainLink]", - "association_chain_name": "str", - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "association_chain_links": "associationChainLinks", - "association_chain_name": "associationChainName", - "item_type": "itemType", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "associationChainLinks": "GsaNewLayoutAssociationChainLink", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - association_chain_links: "list[GsaNewLayoutAssociationChainLink]", - association_chain_name: "str", - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.ASSOCIATIONCHAIN, - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaAssociationChainCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - association_chain_links: list[GsaNewLayoutAssociationChainLink] - association_chain_name: str - item_type: GsaNewLayoutItemType - type: GsaPutType - """ - super().__init__(item_type=item_type, type=type) - self._association_chain_name: str - self._association_chain_links: list[GsaNewLayoutAssociationChainLink] - - self.association_chain_name = association_chain_name - self.association_chain_links = association_chain_links - - @property - def association_chain_name(self) -> "str": - """Gets the association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - - Returns - ------- - str - The association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - """ - return self._association_chain_name - - @association_chain_name.setter - def association_chain_name(self, association_chain_name: "str") -> None: - """Sets the association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - - Parameters - ---------- - association_chain_name: str - The association_chain_name of this GsaAssociationChainCreatePutLayoutItem. - """ - # Field is not nullable - if association_chain_name is None: - raise ValueError("Invalid value for 'association_chain_name', must not be 'None'") - # Field is required - if association_chain_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'association_chain_name', must not be 'Unset'") - self._association_chain_name = association_chain_name - - @property - def association_chain_links(self) -> "list[GsaNewLayoutAssociationChainLink]": - """Gets the association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - - Returns - ------- - list[GsaNewLayoutAssociationChainLink] - The association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - """ - return self._association_chain_links - - @association_chain_links.setter - def association_chain_links( - self, association_chain_links: "list[GsaNewLayoutAssociationChainLink]" - ) -> None: - """Sets the association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - - Parameters - ---------- - association_chain_links: list[GsaNewLayoutAssociationChainLink] - The association_chain_links of this GsaAssociationChainCreatePutLayoutItem. - """ - # Field is not nullable - if association_chain_links is None: - raise ValueError("Invalid value for 'association_chain_links', must not be 'None'") - # Field is required - if association_chain_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'association_chain_links', must not be 'Unset'") - self._association_chain_links = association_chain_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAssociationChainCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute.py index 112da0119..40ee400a7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute.py @@ -68,7 +68,6 @@ class GsaAttribute(ModelBase): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -83,7 +82,6 @@ class GsaAttribute(ModelBase): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -129,7 +127,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType", @@ -146,7 +143,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -161,7 +157,6 @@ def __init__( self._type: GsaAttributeType self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset self._is_hidden_from_search_criteria: bool - self._is_protected: bool self._table: GsaSlimEntity self._display_names: dict[str, str] self._name: str @@ -177,7 +172,6 @@ def __init__( if about_attribute is not Unset: self.about_attribute = about_attribute self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected self.table = table self.display_names = display_names self.name = name @@ -373,36 +367,6 @@ def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") ) self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaAttribute. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaAttribute. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaAttribute. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def table(self) -> "GsaSlimEntity": """Gets the table of this GsaAttribute. @@ -434,7 +398,6 @@ def table(self, table: "GsaSlimEntity") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -446,7 +409,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_already_specified_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_already_specified_smart_attributes_error_detail.py deleted file mode 100644 index e83605600..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_already_specified_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEALREADYSPECIFIED, - table_guid: "str", - ) -> None: - """GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - message: str - reason: GsaSmartAttributesErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._table_guid: str - self._attribute_guid: str - - self.table_guid = table_guid - self.attribute_guid = attribute_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Returns - ------- - str - The table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_based_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_based_access_control_info.py deleted file mode 100644 index fa0154c5d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_based_access_control_info.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_info import ( # noqa: F401 - GsaAccessControlInfo, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeBasedAccessControlInfo(GsaAccessControlInfo): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "current_rule_engine": "GsaRuleEngine", - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "current_rule_engine": "currentRuleEngine", - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "currentRuleEngine": "GsaRuleEngine", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - current_rule_engine: "GsaRuleEngine", - mode: "GsaAccessControlMode" = GsaAccessControlMode.ATTRIBUTEBASED, - ) -> None: - """GsaAttributeBasedAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - current_rule_engine: GsaRuleEngine - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - self._current_rule_engine: GsaRuleEngine - - self.current_rule_engine = current_rule_engine - - @property - def current_rule_engine(self) -> "GsaRuleEngine": - """Gets the current_rule_engine of this GsaAttributeBasedAccessControlInfo. - - Returns - ------- - GsaRuleEngine - The current_rule_engine of this GsaAttributeBasedAccessControlInfo. - """ - return self._current_rule_engine - - @current_rule_engine.setter - def current_rule_engine(self, current_rule_engine: "GsaRuleEngine") -> None: - """Sets the current_rule_engine of this GsaAttributeBasedAccessControlInfo. - - Parameters - ---------- - current_rule_engine: GsaRuleEngine - The current_rule_engine of this GsaAttributeBasedAccessControlInfo. - """ - # Field is not nullable - if current_rule_engine is None: - raise ValueError("Invalid value for 'current_rule_engine', must not be 'None'") - # Field is required - if current_rule_engine is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'current_rule_engine', must not be 'Unset'") - self._current_rule_engine = current_rule_engine - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeBasedAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_create_put_layout_item.py deleted file mode 100644 index 56e033827..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_create_put_layout_item.py +++ /dev/null @@ -1,290 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - "meta_attributes": "list[GsaNewLayoutAttributeItem]", - "read_only": "bool", - "required": "bool", - "tabular_column_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "item_type": "itemType", - "type": "type", - "meta_attributes": "metaAttributes", - "read_only": "readOnly", - "required": "required", - "tabular_column_guids": "tabularColumnGuids", - } - - subtype_mapping: dict[str, str] = { - "metaAttributes": "GsaNewLayoutAttributeItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.ATTRIBUTE, - type: "GsaPutType" = GsaPutType.CREATE, - meta_attributes: "list[GsaNewLayoutAttributeItem] | None | Unset_Type" = Unset, - read_only: "bool | Unset_Type" = Unset, - required: "bool | Unset_Type" = Unset, - tabular_column_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaAttributeCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - item_type: GsaNewLayoutItemType - type: GsaPutType - meta_attributes: list[GsaNewLayoutAttributeItem] | None, optional - read_only: bool, optional - required: bool, optional - tabular_column_guids: list[str] | None, optional - """ - super().__init__(item_type=item_type, type=type) - self._attribute_guid: str - self._required: bool | Unset_Type = Unset - self._read_only: bool | Unset_Type = Unset - self._meta_attributes: list[GsaNewLayoutAttributeItem] | None | Unset_Type = Unset - self._tabular_column_guids: list[str] | None | Unset_Type = Unset - - self.attribute_guid = attribute_guid - if required is not Unset: - self.required = required - if read_only is not Unset: - self.read_only = read_only - if meta_attributes is not Unset: - self.meta_attributes = meta_attributes - if tabular_column_guids is not Unset: - self.tabular_column_guids = tabular_column_guids - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - str - The attribute_guid of this GsaAttributeCreatePutLayoutItem. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def required(self) -> "bool | Unset_Type": - """Gets the required of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The required of this GsaAttributeCreatePutLayoutItem. - """ - return self._required - - @required.setter - def required(self, required: "bool | Unset_Type") -> None: - """Sets the required of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - required: bool | Unset_Type - The required of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if required is None: - raise ValueError("Invalid value for 'required', must not be 'None'") - self._required = required - - @property - def read_only(self) -> "bool | Unset_Type": - """Gets the read_only of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The read_only of this GsaAttributeCreatePutLayoutItem. - """ - return self._read_only - - @read_only.setter - def read_only(self, read_only: "bool | Unset_Type") -> None: - """Sets the read_only of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - read_only: bool | Unset_Type - The read_only of this GsaAttributeCreatePutLayoutItem. - """ - # Field is not nullable - if read_only is None: - raise ValueError("Invalid value for 'read_only', must not be 'None'") - self._read_only = read_only - - @property - def meta_attributes(self) -> "list[GsaNewLayoutAttributeItem] | None | Unset_Type": - """Gets the meta_attributes of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - list[GsaNewLayoutAttributeItem] | None | Unset_Type - The meta_attributes of this GsaAttributeCreatePutLayoutItem. - """ - return self._meta_attributes - - @meta_attributes.setter - def meta_attributes( - self, meta_attributes: "list[GsaNewLayoutAttributeItem] | None | Unset_Type" - ) -> None: - """Sets the meta_attributes of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - meta_attributes: list[GsaNewLayoutAttributeItem] | None | Unset_Type - The meta_attributes of this GsaAttributeCreatePutLayoutItem. - """ - self._meta_attributes = meta_attributes - - @property - def tabular_column_guids(self) -> "list[str] | None | Unset_Type": - """Gets the tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - - Returns - ------- - list[str] | None | Unset_Type - The tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - """ - return self._tabular_column_guids - - @tabular_column_guids.setter - def tabular_column_guids(self, tabular_column_guids: "list[str] | None | Unset_Type") -> None: - """Sets the tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - - Parameters - ---------- - tabular_column_guids: list[str] | None | Unset_Type - The tabular_column_guids of this GsaAttributeCreatePutLayoutItem. - """ - self._tabular_column_guids = tabular_column_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_creation_exception.py index 3d346e12c..dd35e8da8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_creation_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_creation_exception.py @@ -61,7 +61,7 @@ class GsaAttributeCreationException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaAttributeErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaAttributeCreationException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaAttributeErrorDetail", } @@ -82,7 +82,7 @@ class GsaAttributeCreationException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaAttributeErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaAttributeErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaAttributeErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaAttributeCreationException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeCreationException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaAttributeCreationException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeCreationException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_deletion_exception.py index 3633480a6..3590a700e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_deletion_exception.py @@ -61,21 +61,19 @@ class GsaAttributeDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaAttributeDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaAttributeDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaAttributeDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaAttributeDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaAttributeDeletionException. - - Returns - ------- - str - The guid of this GsaAttributeDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaAttributeDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaAttributeDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaAttributeDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_discrete_type_mismatch_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_discrete_type_mismatch_error_detail.py deleted file mode 100644 index a1bd1897c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_discrete_type_mismatch_error_detail.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeDiscreteTypeMismatchErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "actual_discrete_type_guid": "str", - "attribute_guid": "str", - "expected_discrete_type_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "actual_discrete_type_guid": "actualDiscreteTypeGuid", - "attribute_guid": "attributeGuid", - "expected_discrete_type_guid": "expectedDiscreteTypeGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - actual_discrete_type_guid: "str", - attribute_guid: "str", - expected_discrete_type_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.ATTRIBUTEDISCRETETYPEMISMATCH, - ) -> None: - """GsaAttributeDiscreteTypeMismatchErrorDetail - a model defined in Swagger - - Parameters - ---------- - actual_discrete_type_guid: str - attribute_guid: str - expected_discrete_type_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._expected_discrete_type_guid: str - self._actual_discrete_type_guid: str - - self.attribute_guid = attribute_guid - self.expected_discrete_type_guid = expected_discrete_type_guid - self.actual_discrete_type_guid = actual_discrete_type_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def expected_discrete_type_guid(self) -> "str": - """Gets the expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._expected_discrete_type_guid - - @expected_discrete_type_guid.setter - def expected_discrete_type_guid(self, expected_discrete_type_guid: "str") -> None: - """Sets the expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - expected_discrete_type_guid: str - The expected_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if expected_discrete_type_guid is None: - raise ValueError("Invalid value for 'expected_discrete_type_guid', must not be 'None'") - # Field is required - if expected_discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'expected_discrete_type_guid', must not be 'Unset'") - self._expected_discrete_type_guid = expected_discrete_type_guid - - @property - def actual_discrete_type_guid(self) -> "str": - """Gets the actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Returns - ------- - str - The actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - return self._actual_discrete_type_guid - - @actual_discrete_type_guid.setter - def actual_discrete_type_guid(self, actual_discrete_type_guid: "str") -> None: - """Sets the actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - - Parameters - ---------- - actual_discrete_type_guid: str - The actual_discrete_type_guid of this GsaAttributeDiscreteTypeMismatchErrorDetail. - """ - # Field is not nullable - if actual_discrete_type_guid is None: - raise ValueError("Invalid value for 'actual_discrete_type_guid', must not be 'None'") - # Field is required - if actual_discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'actual_discrete_type_guid', must not be 'Unset'") - self._actual_discrete_type_guid = actual_discrete_type_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeDiscreteTypeMismatchErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_detail.py index 98934d6ae..18f30336a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_detail.py @@ -94,7 +94,6 @@ class GsaAttributeErrorDetail(ModelBase): "tabularColumnNameNotProvided".lower(): "#/components/schemas/GsaTabularColumnNameNotProvidedErrorDetail", "duplicateTabularColumnNames".lower(): "#/components/schemas/GsaDuplicateTabularColumnNamesErrorDetail", "tabularColumnNoSuchEntity".lower(): "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail", - "metaAttributeCannotHaveMetaAttribute".lower(): "#/components/schemas/GsaMetaAttributeCannotHaveMetaAttributeErrorDetail", } discriminator: Optional[str] = "reason" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_reason.py index e5f817acb..28ecd63aa 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_reason.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_error_reason.py @@ -43,7 +43,6 @@ class GsaAttributeErrorReason(Enum): Allowed Enum values """ ABOUTATTRIBUTECANNOTBEMETA = "aboutAttributeCannotBeMeta" - METAATTRIBUTECANNOTHAVEMETAATTRIBUTE = "metaAttributeCannotHaveMetaAttribute" DUPLICATEPARAMETERGUIDS = "duplicateParameterGuids" EMPTYAXISNAME = "emptyAxisName" FUNCNOPARAMS = "funcNoParams" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_info.py index 7ff5deb89..58e3f1d5b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_info.py @@ -70,9 +70,9 @@ class GsaAttributeInfo(ModelBase): "primary_data_link_groups": "list[GsaSlimNamedEntity]", "standard_names": "list[GsaSlimNamedEntity]", "type_code": "str", - "foreign_smart_link_groups": "list[GsaSlimNamedEntity]", + "foreign_dynamic_link_groups": "list[GsaSlimNamedEntity]", "ordered_meta_attributes": "list[GsaSlimTypedAttribute]", - "primary_smart_link_groups": "list[GsaSlimNamedEntity]", + "primary_dynamic_link_groups": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -85,9 +85,9 @@ class GsaAttributeInfo(ModelBase): "primary_data_link_groups": "primaryDataLinkGroups", "standard_names": "standardNames", "type_code": "typeCode", - "foreign_smart_link_groups": "foreignSmartLinkGroups", + "foreign_dynamic_link_groups": "foreignDynamicLinkGroups", "ordered_meta_attributes": "orderedMetaAttributes", - "primary_smart_link_groups": "primarySmartLinkGroups", + "primary_dynamic_link_groups": "primaryDynamicLinkGroups", } subtype_mapping: dict[str, str] = { @@ -95,8 +95,8 @@ class GsaAttributeInfo(ModelBase): "standardNames": "GsaSlimNamedEntity", "primaryDataLinkGroups": "GsaSlimNamedEntity", "foreignDataLinkGroups": "GsaSlimNamedEntity", - "primarySmartLinkGroups": "GsaSlimNamedEntity", - "foreignSmartLinkGroups": "GsaSlimNamedEntity", + "primaryDynamicLinkGroups": "GsaSlimNamedEntity", + "foreignDynamicLinkGroups": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -113,9 +113,9 @@ def __init__( primary_data_link_groups: "list[GsaSlimNamedEntity]", standard_names: "list[GsaSlimNamedEntity]", type_code: "str", - foreign_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, + foreign_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ordered_meta_attributes: "list[GsaSlimTypedAttribute] | None | Unset_Type" = Unset, - primary_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, + primary_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: """GsaAttributeInfo - a model defined in Swagger @@ -130,9 +130,9 @@ def __init__( primary_data_link_groups: list[GsaSlimNamedEntity] standard_names: list[GsaSlimNamedEntity] type_code: str - foreign_smart_link_groups: list[GsaSlimNamedEntity] | None, optional + foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None, optional ordered_meta_attributes: list[GsaSlimTypedAttribute] | None, optional - primary_smart_link_groups: list[GsaSlimNamedEntity] | None, optional + primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None, optional """ self._type_code: str self._chartable: bool @@ -144,8 +144,8 @@ def __init__( self._standard_names: list[GsaSlimNamedEntity] self._primary_data_link_groups: list[GsaSlimNamedEntity] self._foreign_data_link_groups: list[GsaSlimNamedEntity] - self._primary_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._foreign_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset + self._primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset + self._foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type = Unset self.type_code = type_code self.chartable = chartable @@ -158,10 +158,10 @@ def __init__( self.standard_names = standard_names self.primary_data_link_groups = primary_data_link_groups self.foreign_data_link_groups = foreign_data_link_groups - if primary_smart_link_groups is not Unset: - self.primary_smart_link_groups = primary_smart_link_groups - if foreign_smart_link_groups is not Unset: - self.foreign_smart_link_groups = foreign_smart_link_groups + if primary_dynamic_link_groups is not Unset: + self.primary_dynamic_link_groups = primary_dynamic_link_groups + if foreign_dynamic_link_groups is not Unset: + self.foreign_dynamic_link_groups = foreign_dynamic_link_groups @property def type_code(self) -> "str": @@ -450,52 +450,52 @@ def foreign_data_link_groups( self._foreign_data_link_groups = foreign_data_link_groups @property - def primary_smart_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the primary_smart_link_groups of this GsaAttributeInfo. + def primary_dynamic_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + """Gets the primary_dynamic_link_groups of this GsaAttributeInfo. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The primary_smart_link_groups of this GsaAttributeInfo. + The primary_dynamic_link_groups of this GsaAttributeInfo. """ - return self._primary_smart_link_groups + return self._primary_dynamic_link_groups - @primary_smart_link_groups.setter - def primary_smart_link_groups( - self, primary_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" + @primary_dynamic_link_groups.setter + def primary_dynamic_link_groups( + self, primary_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" ) -> None: - """Sets the primary_smart_link_groups of this GsaAttributeInfo. + """Sets the primary_dynamic_link_groups of this GsaAttributeInfo. Parameters ---------- - primary_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type - The primary_smart_link_groups of this GsaAttributeInfo. + primary_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type + The primary_dynamic_link_groups of this GsaAttributeInfo. """ - self._primary_smart_link_groups = primary_smart_link_groups + self._primary_dynamic_link_groups = primary_dynamic_link_groups @property - def foreign_smart_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the foreign_smart_link_groups of this GsaAttributeInfo. + def foreign_dynamic_link_groups(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + """Gets the foreign_dynamic_link_groups of this GsaAttributeInfo. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The foreign_smart_link_groups of this GsaAttributeInfo. + The foreign_dynamic_link_groups of this GsaAttributeInfo. """ - return self._foreign_smart_link_groups + return self._foreign_dynamic_link_groups - @foreign_smart_link_groups.setter - def foreign_smart_link_groups( - self, foreign_smart_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" + @foreign_dynamic_link_groups.setter + def foreign_dynamic_link_groups( + self, foreign_dynamic_link_groups: "list[GsaSlimNamedEntity] | None | Unset_Type" ) -> None: - """Sets the foreign_smart_link_groups of this GsaAttributeInfo. + """Sets the foreign_dynamic_link_groups of this GsaAttributeInfo. Parameters ---------- - foreign_smart_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type - The foreign_smart_link_groups of this GsaAttributeInfo. + foreign_dynamic_link_groups: list[GsaSlimNamedEntity] | None | Unset_Type + The foreign_dynamic_link_groups of this GsaAttributeInfo. """ - self._foreign_smart_link_groups = foreign_smart_link_groups + self._foreign_dynamic_link_groups = foreign_dynamic_link_groups @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_link_pair.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_link_pair.py index 83044b49c..4a89faab6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_link_pair.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_link_pair.py @@ -61,8 +61,8 @@ class GsaAttributeLinkPair(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "attribute_source": "GsaTargetAttribute", - "attribute_target": "GsaTargetAttribute", + "attribute_source": "GsaSlimAttribute", + "attribute_target": "GsaSlimAttribute", } attribute_map: dict[str, str] = { @@ -71,8 +71,8 @@ class GsaAttributeLinkPair(ModelBase): } subtype_mapping: dict[str, str] = { - "attributeSource": "GsaTargetAttribute", - "attributeTarget": "GsaTargetAttribute", + "attributeSource": "GsaSlimAttribute", + "attributeTarget": "GsaSlimAttribute", } discriminator: Optional[str] = None @@ -80,76 +80,72 @@ class GsaAttributeLinkPair(ModelBase): def __init__( self, *, - attribute_source: "GsaTargetAttribute", - attribute_target: "GsaTargetAttribute", + attribute_source: "GsaSlimAttribute | Unset_Type" = Unset, + attribute_target: "GsaSlimAttribute | Unset_Type" = Unset, ) -> None: """GsaAttributeLinkPair - a model defined in Swagger Parameters ---------- - attribute_source: GsaTargetAttribute - attribute_target: GsaTargetAttribute + attribute_source: GsaSlimAttribute, optional + attribute_target: GsaSlimAttribute, optional """ - self._attribute_source: GsaTargetAttribute - self._attribute_target: GsaTargetAttribute + self._attribute_source: GsaSlimAttribute | Unset_Type = Unset + self._attribute_target: GsaSlimAttribute | Unset_Type = Unset - self.attribute_source = attribute_source - self.attribute_target = attribute_target + if attribute_source is not Unset: + self.attribute_source = attribute_source + if attribute_target is not Unset: + self.attribute_target = attribute_target @property - def attribute_source(self) -> "GsaTargetAttribute": + def attribute_source(self) -> "GsaSlimAttribute | Unset_Type": """Gets the attribute_source of this GsaAttributeLinkPair. Returns ------- - GsaTargetAttribute + GsaSlimAttribute | Unset_Type The attribute_source of this GsaAttributeLinkPair. """ return self._attribute_source @attribute_source.setter - def attribute_source(self, attribute_source: "GsaTargetAttribute") -> None: + def attribute_source(self, attribute_source: "GsaSlimAttribute | Unset_Type") -> None: """Sets the attribute_source of this GsaAttributeLinkPair. Parameters ---------- - attribute_source: GsaTargetAttribute + attribute_source: GsaSlimAttribute | Unset_Type The attribute_source of this GsaAttributeLinkPair. """ # Field is not nullable if attribute_source is None: raise ValueError("Invalid value for 'attribute_source', must not be 'None'") - # Field is required - if attribute_source is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_source', must not be 'Unset'") self._attribute_source = attribute_source @property - def attribute_target(self) -> "GsaTargetAttribute": + def attribute_target(self) -> "GsaSlimAttribute | Unset_Type": """Gets the attribute_target of this GsaAttributeLinkPair. Returns ------- - GsaTargetAttribute + GsaSlimAttribute | Unset_Type The attribute_target of this GsaAttributeLinkPair. """ return self._attribute_target @attribute_target.setter - def attribute_target(self, attribute_target: "GsaTargetAttribute") -> None: + def attribute_target(self, attribute_target: "GsaSlimAttribute | Unset_Type") -> None: """Sets the attribute_target of this GsaAttributeLinkPair. Parameters ---------- - attribute_target: GsaTargetAttribute + attribute_target: GsaSlimAttribute | Unset_Type The attribute_target of this GsaAttributeLinkPair. """ # Field is not nullable if attribute_target is None: raise ValueError("Invalid value for 'attribute_target', must not be 'None'") - # Field is required - if attribute_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_target', must not be 'Unset'") self._attribute_target = attribute_target @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_not_on_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_not_on_table_error_detail.py deleted file mode 100644 index f5905dcc0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_not_on_table_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeNotOnTableErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.ATTRIBUTENOTONTABLE, - table_guid: "str", - ) -> None: - """GsaAttributeNotOnTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._table_guid: str - - self.attribute_guid = attribute_guid - self.table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeNotOnTableErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeNotOnTableErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeNotOnTableErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeNotOnTableErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaAttributeNotOnTableErrorDetail. - - Returns - ------- - str - The table_guid of this GsaAttributeNotOnTableErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaAttributeNotOnTableErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaAttributeNotOnTableErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeNotOnTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py deleted file mode 100644 index 6d2958f5f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_discrete_type_mismatch_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "source_attribute_guid": "str", - "target_attribute_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "source_attribute_guid": "sourceAttributeGuid", - "target_attribute_guid": "targetAttributeGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEPAIRDISCRETETYPEMISMATCH, - source_attribute_guid: "str", - target_attribute_guid: "str", - ) -> None: - """GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - source_attribute_guid: str - target_attribute_guid: str - """ - super().__init__(message=message, reason=reason) - self._source_attribute_guid: str - self._target_attribute_guid: str - - self.source_attribute_guid = source_attribute_guid - self.target_attribute_guid = target_attribute_guid - - @property - def source_attribute_guid(self) -> "str": - """Gets the source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - return self._source_attribute_guid - - @source_attribute_guid.setter - def source_attribute_guid(self, source_attribute_guid: "str") -> None: - """Sets the source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - source_attribute_guid: str - The source_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if source_attribute_guid is None: - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'None'") - # Field is required - if source_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'Unset'") - self._source_attribute_guid = source_attribute_guid - - @property - def target_attribute_guid(self) -> "str": - """Gets the target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - return self._target_attribute_guid - - @target_attribute_guid.setter - def target_attribute_guid(self, target_attribute_guid: "str") -> None: - """Sets the target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - target_attribute_guid: str - The target_attribute_guid of this GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if target_attribute_guid is None: - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'None'") - # Field is required - if target_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'Unset'") - self._target_attribute_guid = target_attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py deleted file mode 100644 index 1b18537f1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_pair_type_mismatch_smart_attributes_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributePairTypeMismatchSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "source_attribute_guid": "str", - "target_attribute_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "source_attribute_guid": "sourceAttributeGuid", - "target_attribute_guid": "targetAttributeGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTEPAIRTYPEMISMATCH, - source_attribute_guid: "str", - target_attribute_guid: "str", - ) -> None: - """GsaAttributePairTypeMismatchSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - source_attribute_guid: str - target_attribute_guid: str - """ - super().__init__(message=message, reason=reason) - self._source_attribute_guid: str - self._target_attribute_guid: str - - self.source_attribute_guid = source_attribute_guid - self.target_attribute_guid = target_attribute_guid - - @property - def source_attribute_guid(self) -> "str": - """Gets the source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - return self._source_attribute_guid - - @source_attribute_guid.setter - def source_attribute_guid(self, source_attribute_guid: "str") -> None: - """Sets the source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - source_attribute_guid: str - The source_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if source_attribute_guid is None: - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'None'") - # Field is required - if source_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_attribute_guid', must not be 'Unset'") - self._source_attribute_guid = source_attribute_guid - - @property - def target_attribute_guid(self) -> "str": - """Gets the target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Returns - ------- - str - The target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - return self._target_attribute_guid - - @target_attribute_guid.setter - def target_attribute_guid(self, target_attribute_guid: "str") -> None: - """Sets the target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - - Parameters - ---------- - target_attribute_guid: str - The target_attribute_guid of this GsaAttributePairTypeMismatchSmartAttributesErrorDetail. - """ - # Field is not nullable - if target_attribute_guid is None: - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'None'") - # Field is required - if target_attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute_guid', must not be 'Unset'") - self._target_attribute_guid = target_attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributePairTypeMismatchSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py deleted file mode 100644 index 7cfd31550..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_attribute_type_not_supported_smart_attributes_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaAttributeTypeNotSupportedSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "attribute_type": "GsaAttributeType", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "attribute_type": "attributeType", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "attributeType": "GsaAttributeType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - attribute_type: "GsaAttributeType", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.ATTRIBUTETYPENOTSUPPORTED, - ) -> None: - """GsaAttributeTypeNotSupportedSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - attribute_type: GsaAttributeType - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str - self._attribute_type: GsaAttributeType - - self.attribute_guid = attribute_guid - self.attribute_type = attribute_type - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @property - def attribute_type(self) -> "GsaAttributeType": - """Gets the attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Returns - ------- - GsaAttributeType - The attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - return self._attribute_type - - @attribute_type.setter - def attribute_type(self, attribute_type: "GsaAttributeType") -> None: - """Sets the attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_type: GsaAttributeType - The attribute_type of this GsaAttributeTypeNotSupportedSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_type is None: - raise ValueError("Invalid value for 'attribute_type', must not be 'None'") - # Field is required - if attribute_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_type', must not be 'Unset'") - self._attribute_type = attribute_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaAttributeTypeNotSupportedSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_blob_info_dto.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_blob_info_dto.py deleted file mode 100644 index ae0764805..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_blob_info_dto.py +++ /dev/null @@ -1,257 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBlobInfoDto(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "full_path": "str", - "last_write_time_utc": "datetime", - "length": "int", - "name": "str", - } - - attribute_map: dict[str, str] = { - "full_path": "fullPath", - "last_write_time_utc": "lastWriteTimeUtc", - "length": "length", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - full_path: "str", - last_write_time_utc: "datetime", - length: "int", - name: "str", - ) -> None: - """GsaBlobInfoDto - a model defined in Swagger - - Parameters - ---------- - full_path: str - last_write_time_utc: datetime - length: int - name: str - """ - self._name: str - self._full_path: str - self._length: int - self._last_write_time_utc: datetime - - self.name = name - self.full_path = full_path - self.length = length - self.last_write_time_utc = last_write_time_utc - - @property - def name(self) -> "str": - """Gets the name of this GsaBlobInfoDto. - Name of the blob. - - Returns - ------- - str - The name of this GsaBlobInfoDto. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaBlobInfoDto. - Name of the blob. - - Parameters - ---------- - name: str - The name of this GsaBlobInfoDto. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def full_path(self) -> "str": - """Gets the full_path of this GsaBlobInfoDto. - Full path of the blob. Path segments are separated by '/' The last segment is always blob name. - - Returns - ------- - str - The full_path of this GsaBlobInfoDto. - """ - return self._full_path - - @full_path.setter - def full_path(self, full_path: "str") -> None: - """Sets the full_path of this GsaBlobInfoDto. - Full path of the blob. Path segments are separated by '/' The last segment is always blob name. - - Parameters - ---------- - full_path: str - The full_path of this GsaBlobInfoDto. - """ - # Field is not nullable - if full_path is None: - raise ValueError("Invalid value for 'full_path', must not be 'None'") - # Field is required - if full_path is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'full_path', must not be 'Unset'") - self._full_path = full_path - - @property - def length(self) -> "int": - """Gets the length of this GsaBlobInfoDto. - Blob size in bytes. - - Returns - ------- - int - The length of this GsaBlobInfoDto. - """ - return self._length - - @length.setter - def length(self, length: "int") -> None: - """Sets the length of this GsaBlobInfoDto. - Blob size in bytes. - - Parameters - ---------- - length: int - The length of this GsaBlobInfoDto. - """ - # Field is not nullable - if length is None: - raise ValueError("Invalid value for 'length', must not be 'None'") - # Field is required - if length is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'length', must not be 'Unset'") - self._length = length - - @property - def last_write_time_utc(self) -> "datetime": - """Gets the last_write_time_utc of this GsaBlobInfoDto. - Last modification date. - - Returns - ------- - datetime - The last_write_time_utc of this GsaBlobInfoDto. - """ - return self._last_write_time_utc - - @last_write_time_utc.setter - def last_write_time_utc(self, last_write_time_utc: "datetime") -> None: - """Sets the last_write_time_utc of this GsaBlobInfoDto. - Last modification date. - - Parameters - ---------- - last_write_time_utc: datetime - The last_write_time_utc of this GsaBlobInfoDto. - """ - # Field is not nullable - if last_write_time_utc is None: - raise ValueError("Invalid value for 'last_write_time_utc', must not be 'None'") - # Field is required - if last_write_time_utc is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'last_write_time_utc', must not be 'Unset'") - self._last_write_time_utc = last_write_time_utc - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBlobInfoDto): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_bracket_mismatch_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_bracket_mismatch_unit_equation_error_detail.py deleted file mode 100644 index 9132b8310..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_bracket_mismatch_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaBracketMismatchUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.BRACKETMISMATCH, - ) -> None: - """GsaBracketMismatchUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaBracketMismatchUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_category_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_category_replace_permission_category_error_detail.py deleted file mode 100644 index b525a9f4c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_category_replace_permission_category_error_detail.py +++ /dev/null @@ -1,223 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCategoryReplacePermissionCategoryErrorDetail(GsaReplacePermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaPermissionCategoryErrorDetail]", - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaPermissionCategoryErrorDetail]", - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.CATEGORY, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCategoryReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] - message: str - reason: GsaReplacePermissionCategoryErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - self._errors: list[GsaPermissionCategoryErrorDetail] - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - self.errors = errors - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail]": - """Gets the errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[GsaPermissionCategoryErrorDetail] - The errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail]") -> None: - """Sets the errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] - The errors of this GsaCategoryReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCategoryReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data.py deleted file mode 100644 index 21882cd11..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaChartData(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaChartDataType", - "bubbleAxisValue": "GsaDataExportRange", - } - - discriminator_value_class_map = { - "point".lower(): "#/components/schemas/GsaPointChartData", - "integer".lower(): "#/components/schemas/GsaIntegerChartData", - "range".lower(): "#/components/schemas/GsaRangeChartData", - "logical".lower(): "#/components/schemas/GsaLogicalChartData", - "discrete".lower(): "#/components/schemas/GsaDiscreteChartData", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaChartDataType", - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - """ - self._type: GsaChartDataType - self._record_version_guid: str | Unset_Type = Unset - self._bubble_axis_value: GsaDataExportRange | Unset_Type = Unset - - self.type = type - if record_version_guid is not Unset: - self.record_version_guid = record_version_guid - if bubble_axis_value is not Unset: - self.bubble_axis_value = bubble_axis_value - - @property - def type(self) -> "GsaChartDataType": - """Gets the type of this GsaChartData. - - Returns - ------- - GsaChartDataType - The type of this GsaChartData. - """ - return self._type - - @type.setter - def type(self, type: "GsaChartDataType") -> None: - """Sets the type of this GsaChartData. - - Parameters - ---------- - type: GsaChartDataType - The type of this GsaChartData. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def record_version_guid(self) -> "str | Unset_Type": - """Gets the record_version_guid of this GsaChartData. - The record version associated with this chart data. - - Returns - ------- - str | Unset_Type - The record_version_guid of this GsaChartData. - """ - return self._record_version_guid - - @record_version_guid.setter - def record_version_guid(self, record_version_guid: "str | Unset_Type") -> None: - """Sets the record_version_guid of this GsaChartData. - The record version associated with this chart data. - - Parameters - ---------- - record_version_guid: str | Unset_Type - The record_version_guid of this GsaChartData. - """ - # Field is not nullable - if record_version_guid is None: - raise ValueError("Invalid value for 'record_version_guid', must not be 'None'") - self._record_version_guid = record_version_guid - - @property - def bubble_axis_value(self) -> "GsaDataExportRange | Unset_Type": - """Gets the bubble_axis_value of this GsaChartData. - - Returns - ------- - GsaDataExportRange | Unset_Type - The bubble_axis_value of this GsaChartData. - """ - return self._bubble_axis_value - - @bubble_axis_value.setter - def bubble_axis_value(self, bubble_axis_value: "GsaDataExportRange | Unset_Type") -> None: - """Sets the bubble_axis_value of this GsaChartData. - - Parameters - ---------- - bubble_axis_value: GsaDataExportRange | Unset_Type - The bubble_axis_value of this GsaChartData. - """ - # Field is not nullable - if bubble_axis_value is None: - raise ValueError("Invalid value for 'bubble_axis_value', must not be 'None'") - self._bubble_axis_value = bubble_axis_value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data_type.py deleted file mode 100644 index b3dfec60f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_chart_data_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaChartDataType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INTEGER = "integer" - POINT = "point" - RANGE = "range" - LOGICAL = "logical" - DISCRETE = "discrete" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_circular_reference_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_circular_reference_folder_move_error_detail.py deleted file mode 100644 index d6e08fee6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_circular_reference_folder_move_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCircularReferenceFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.CIRCULARREFERENCE, - ) -> None: - """GsaCircularReferenceFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCircularReferenceFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_missing_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_missing_currency_error_detail.py deleted file mode 100644 index b405d3679..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_missing_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCodeMissingCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.CODEMISSING, - ) -> None: - """GsaCodeMissingCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCodeMissingCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_whitespace_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_whitespace_currency_error_detail.py deleted file mode 100644 index 0bbb52d65..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_code_whitespace_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCodeWhitespaceCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "currency_code": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "currency_code": "currencyCode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.CODEWHITESPACE, - currency_code: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCodeWhitespaceCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - currency_code: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._currency_code: str | None | Unset_Type = Unset - - if currency_code is not Unset: - self.currency_code = currency_code - - @property - def currency_code(self) -> "str | None | Unset_Type": - """Gets the currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code: "str | None | Unset_Type") -> None: - """Sets the currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - - Parameters - ---------- - currency_code: str | None | Unset_Type - The currency_code of this GsaCodeWhitespaceCurrencyErrorDetail. - """ - self._currency_code = currency_code - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCodeWhitespaceCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_config_invalid_json_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_config_invalid_json_file_error_detail.py deleted file mode 100644 index 8e7fbb20c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_config_invalid_json_file_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConfigInvalidJsonFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.CONFIGINVALIDJSON, - ) -> None: - """GsaConfigInvalidJsonFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConfigInvalidJsonFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_configuration_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_configuration_details.py deleted file mode 100644 index 1dd2d6762..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_configuration_details.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConfigurationDetails(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "connection_details": "GsaConnectionDetails", - "enabled": "bool", - "language": "str", - } - - attribute_map: dict[str, str] = { - "connection_details": "connectionDetails", - "enabled": "enabled", - "language": "language", - } - - subtype_mapping: dict[str, str] = { - "connectionDetails": "GsaConnectionDetails", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - connection_details: "GsaConnectionDetails", - enabled: "bool", - language: "str", - ) -> None: - """GsaConfigurationDetails - a model defined in Swagger - - Parameters - ---------- - connection_details: GsaConnectionDetails - enabled: bool - language: str - """ - self._language: str - self._connection_details: GsaConnectionDetails - self._enabled: bool - - self.language = language - self.connection_details = connection_details - self.enabled = enabled - - @property - def language(self) -> "str": - """Gets the language of this GsaConfigurationDetails. - - Returns - ------- - str - The language of this GsaConfigurationDetails. - """ - return self._language - - @language.setter - def language(self, language: "str") -> None: - """Sets the language of this GsaConfigurationDetails. - - Parameters - ---------- - language: str - The language of this GsaConfigurationDetails. - """ - # Field is not nullable - if language is None: - raise ValueError("Invalid value for 'language', must not be 'None'") - # Field is required - if language is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'language', must not be 'Unset'") - self._language = language - - @property - def connection_details(self) -> "GsaConnectionDetails": - """Gets the connection_details of this GsaConfigurationDetails. - - Returns - ------- - GsaConnectionDetails - The connection_details of this GsaConfigurationDetails. - """ - return self._connection_details - - @connection_details.setter - def connection_details(self, connection_details: "GsaConnectionDetails") -> None: - """Sets the connection_details of this GsaConfigurationDetails. - - Parameters - ---------- - connection_details: GsaConnectionDetails - The connection_details of this GsaConfigurationDetails. - """ - # Field is not nullable - if connection_details is None: - raise ValueError("Invalid value for 'connection_details', must not be 'None'") - # Field is required - if connection_details is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'connection_details', must not be 'Unset'") - self._connection_details = connection_details - - @property - def enabled(self) -> "bool": - """Gets the enabled of this GsaConfigurationDetails. - - Returns - ------- - bool - The enabled of this GsaConfigurationDetails. - """ - return self._enabled - - @enabled.setter - def enabled(self, enabled: "bool") -> None: - """Sets the enabled of this GsaConfigurationDetails. - - Parameters - ---------- - enabled: bool - The enabled of this GsaConfigurationDetails. - """ - # Field is not nullable - if enabled is None: - raise ValueError("Invalid value for 'enabled', must not be 'None'") - # Field is required - if enabled is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'enabled', must not be 'Unset'") - self._enabled = enabled - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConfigurationDetails): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_connection_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_connection_details.py index bdc1f7a48..4e073e310 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_connection_details.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_connection_details.py @@ -64,8 +64,8 @@ class GsaConnectionDetails(ModelBase): "data_source": "str", "initial_catalog": "str", "additional_sql_parameters": "str", + "sql_password": "str", "sql_username": "str", - "use_configuration_database_credentials": "bool", "use_integrated_security": "bool", } @@ -73,8 +73,8 @@ class GsaConnectionDetails(ModelBase): "data_source": "dataSource", "initial_catalog": "initialCatalog", "additional_sql_parameters": "additionalSqlParameters", + "sql_password": "sqlPassword", "sql_username": "sqlUsername", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", "use_integrated_security": "useIntegratedSecurity", } @@ -88,9 +88,9 @@ def __init__( data_source: "str", initial_catalog: "str", additional_sql_parameters: "str | None | Unset_Type" = Unset, + sql_password: "str | None | Unset_Type" = Unset, sql_username: "str | None | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | Unset_Type" = Unset, - use_integrated_security: "bool | Unset_Type" = Unset, + use_integrated_security: "bool | None | Unset_Type" = Unset, ) -> None: """GsaConnectionDetails - a model defined in Swagger @@ -99,25 +99,25 @@ def __init__( data_source: str initial_catalog: str additional_sql_parameters: str | None, optional + sql_password: str | None, optional sql_username: str | None, optional - use_configuration_database_credentials: bool, optional - use_integrated_security: bool, optional + use_integrated_security: bool | None, optional """ self._data_source: str - self._initial_catalog: str - self._use_configuration_database_credentials: bool | Unset_Type = Unset - self._use_integrated_security: bool | Unset_Type = Unset + self._use_integrated_security: bool | None | Unset_Type = Unset self._sql_username: str | None | Unset_Type = Unset + self._sql_password: str | None | Unset_Type = Unset + self._initial_catalog: str self._additional_sql_parameters: str | None | Unset_Type = Unset self.data_source = data_source - self.initial_catalog = initial_catalog - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials if use_integrated_security is not Unset: self.use_integrated_security = use_integrated_security if sql_username is not Unset: self.sql_username = sql_username + if sql_password is not Unset: + self.sql_password = sql_password + self.initial_catalog = initial_catalog if additional_sql_parameters is not Unset: self.additional_sql_parameters = additional_sql_parameters @@ -152,121 +152,111 @@ def data_source(self, data_source: "str") -> None: self._data_source = data_source @property - def initial_catalog(self) -> "str": - """Gets the initial_catalog of this GsaConnectionDetails. - The name of the database in SQL server + def use_integrated_security(self) -> "bool | None | Unset_Type": + """Gets the use_integrated_security of this GsaConnectionDetails. + Set to true if the SQL connection to the new database should use Windows authentication Returns ------- - str - The initial_catalog of this GsaConnectionDetails. + bool | None | Unset_Type + The use_integrated_security of this GsaConnectionDetails. """ - return self._initial_catalog + return self._use_integrated_security - @initial_catalog.setter - def initial_catalog(self, initial_catalog: "str") -> None: - """Sets the initial_catalog of this GsaConnectionDetails. - The name of the database in SQL server + @use_integrated_security.setter + def use_integrated_security(self, use_integrated_security: "bool | None | Unset_Type") -> None: + """Sets the use_integrated_security of this GsaConnectionDetails. + Set to true if the SQL connection to the new database should use Windows authentication Parameters ---------- - initial_catalog: str - The initial_catalog of this GsaConnectionDetails. + use_integrated_security: bool | None | Unset_Type + The use_integrated_security of this GsaConnectionDetails. """ - # Field is not nullable - if initial_catalog is None: - raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") - # Field is required - if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") - self._initial_catalog = initial_catalog + self._use_integrated_security = use_integrated_security @property - def use_configuration_database_credentials(self) -> "bool | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaConnectionDetails. - Set to true if the SQL connection is using the credentials from the Configuration database. + def sql_username(self) -> "str | None | Unset_Type": + """Gets the sql_username of this GsaConnectionDetails. + The username to use if the new database should use SQL authentication. The password must also be provided. Returns ------- - bool | Unset_Type - The use_configuration_database_credentials of this GsaConnectionDetails. + str | None | Unset_Type + The sql_username of this GsaConnectionDetails. """ - return self._use_configuration_database_credentials + return self._sql_username - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaConnectionDetails. - Set to true if the SQL connection is using the credentials from the Configuration database. + @sql_username.setter + def sql_username(self, sql_username: "str | None | Unset_Type") -> None: + """Sets the sql_username of this GsaConnectionDetails. + The username to use if the new database should use SQL authentication. The password must also be provided. Parameters ---------- - use_configuration_database_credentials: bool | Unset_Type - The use_configuration_database_credentials of this GsaConnectionDetails. + sql_username: str | None | Unset_Type + The sql_username of this GsaConnectionDetails. """ - # Field is not nullable - if use_configuration_database_credentials is None: - raise ValueError( - "Invalid value for 'use_configuration_database_credentials', must not be 'None'" - ) - self._use_configuration_database_credentials = use_configuration_database_credentials + self._sql_username = sql_username @property - def use_integrated_security(self) -> "bool | Unset_Type": - """Gets the use_integrated_security of this GsaConnectionDetails. - Set to true if the SQL connection to the database is using Windows authentication + def sql_password(self) -> "str | None | Unset_Type": + """Gets the sql_password of this GsaConnectionDetails. + The password to use if the new database should use SQL authentication. The username must also be provided. Returns ------- - bool | Unset_Type - The use_integrated_security of this GsaConnectionDetails. + str | None | Unset_Type + The sql_password of this GsaConnectionDetails. """ - return self._use_integrated_security + return self._sql_password - @use_integrated_security.setter - def use_integrated_security(self, use_integrated_security: "bool | Unset_Type") -> None: - """Sets the use_integrated_security of this GsaConnectionDetails. - Set to true if the SQL connection to the database is using Windows authentication + @sql_password.setter + def sql_password(self, sql_password: "str | None | Unset_Type") -> None: + """Sets the sql_password of this GsaConnectionDetails. + The password to use if the new database should use SQL authentication. The username must also be provided. Parameters ---------- - use_integrated_security: bool | Unset_Type - The use_integrated_security of this GsaConnectionDetails. + sql_password: str | None | Unset_Type + The sql_password of this GsaConnectionDetails. """ - # Field is not nullable - if use_integrated_security is None: - raise ValueError("Invalid value for 'use_integrated_security', must not be 'None'") - self._use_integrated_security = use_integrated_security + self._sql_password = sql_password @property - def sql_username(self) -> "str | None | Unset_Type": - """Gets the sql_username of this GsaConnectionDetails. - The username used if the database is using SQL authentication. + def initial_catalog(self) -> "str": + """Gets the initial_catalog of this GsaConnectionDetails. + The name of the database in SQL server Returns ------- - str | None | Unset_Type - The sql_username of this GsaConnectionDetails. + str + The initial_catalog of this GsaConnectionDetails. """ - return self._sql_username + return self._initial_catalog - @sql_username.setter - def sql_username(self, sql_username: "str | None | Unset_Type") -> None: - """Sets the sql_username of this GsaConnectionDetails. - The username used if the database is using SQL authentication. + @initial_catalog.setter + def initial_catalog(self, initial_catalog: "str") -> None: + """Sets the initial_catalog of this GsaConnectionDetails. + The name of the database in SQL server Parameters ---------- - sql_username: str | None | Unset_Type - The sql_username of this GsaConnectionDetails. + initial_catalog: str + The initial_catalog of this GsaConnectionDetails. """ - self._sql_username = sql_username + # Field is not nullable + if initial_catalog is None: + raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") + # Field is required + if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") + self._initial_catalog = initial_catalog @property def additional_sql_parameters(self) -> "str | None | Unset_Type": """Gets the additional_sql_parameters of this GsaConnectionDetails. - (Optional) Any additional parameters added to the SQL connection string for the database. + (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. Returns ------- @@ -280,7 +270,7 @@ def additional_sql_parameters( self, additional_sql_parameters: "str | None | Unset_Type" ) -> None: """Sets the additional_sql_parameters of this GsaConnectionDetails. - (Optional) Any additional parameters added to the SQL connection string for the database. + (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_creation_exception.py deleted file mode 100644 index 970200791..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaConstantErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaConstantErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaConstantErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaConstantCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaConstantErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaConstantErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaConstantCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaConstantCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaConstantCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaConstantCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaConstantCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaConstantCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaConstantCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaConstantCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaConstantCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaConstantCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaConstantCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaConstantCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaConstantErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaConstantCreationException. - - Returns - ------- - list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaConstantErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaConstantCreationException. - - Parameters - ---------- - errors: list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_deletion_exception.py index 0cc1e88ad..bb4315d8f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_deletion_exception.py @@ -61,21 +61,19 @@ class GsaConstantDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaConstantDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaConstantDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaConstantDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaConstantDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaConstantDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaConstantDeletionException. - - Returns - ------- - str - The guid of this GsaConstantDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaConstantDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaConstantDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaConstantDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_detail.py deleted file mode 100644 index 0fc67b975..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaConstantErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityConstantErrorDetail", - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitConstantErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason", - ) -> None: - """GsaConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - """ - self._message: str - self._reason: GsaConstantErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaConstantErrorDetail. - - Returns - ------- - str - The message of this GsaConstantErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaConstantErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaConstantErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaConstantErrorReason": - """Gets the reason of this GsaConstantErrorDetail. - - Returns - ------- - GsaConstantErrorReason - The reason of this GsaConstantErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaConstantErrorReason") -> None: - """Sets the reason of this GsaConstantErrorDetail. - - Parameters - ---------- - reason: GsaConstantErrorReason - The reason of this GsaConstantErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_reason.py deleted file mode 100644 index 9c751867a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaConstantErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - NOSUCHUNIT = "noSuchUnit" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_update_exception.py deleted file mode 100644 index 8491e2c66..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_update_exception.py +++ /dev/null @@ -1,238 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaConstantUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "constant_guid": "str", - "errors": "list[GsaConstantErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "constant_guid": "constantGuid", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaConstantErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - constant_guid: "str | Unset_Type" = Unset, - errors: "list[GsaConstantErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaConstantUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - constant_guid: str, optional - errors: list[GsaConstantErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._constant_guid: str | Unset_Type = Unset - self._errors: list[GsaConstantErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if constant_guid is not Unset: - self.constant_guid = constant_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaConstantUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaConstantUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaConstantUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaConstantUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaConstantUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaConstantUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaConstantUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaConstantUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def constant_guid(self) -> "str | Unset_Type": - """Gets the constant_guid of this GsaConstantUpdateException. - - Returns - ------- - str | Unset_Type - The constant_guid of this GsaConstantUpdateException. - """ - return self._constant_guid - - @constant_guid.setter - def constant_guid(self, constant_guid: "str | Unset_Type") -> None: - """Sets the constant_guid of this GsaConstantUpdateException. - - Parameters - ---------- - constant_guid: str | Unset_Type - The constant_guid of this GsaConstantUpdateException. - """ - # Field is not nullable - if constant_guid is None: - raise ValueError("Invalid value for 'constant_guid', must not be 'None'") - self._constant_guid = constant_guid - - @property - def errors(self) -> "list[GsaConstantErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaConstantUpdateException. - - Returns - ------- - list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaConstantErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaConstantUpdateException. - - Parameters - ---------- - errors: list[GsaConstantErrorDetail] | None | Unset_Type - The errors of this GsaConstantUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constants_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constants_info.py index 2d29f0486..82f4dcb07 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constants_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constants_info.py @@ -61,7 +61,7 @@ class GsaConstantsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "constants": "list[GsaConstant]", + "constants": "list[GsaSlimConstant]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaConstantsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "constants": "GsaConstant", + "constants": "GsaSlimConstant", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaConstantsInfo(ModelBase): def __init__( self, *, - constants: "list[GsaConstant] | None | Unset_Type" = Unset, + constants: "list[GsaSlimConstant] | None | Unset_Type" = Unset, ) -> None: """GsaConstantsInfo - a model defined in Swagger Parameters ---------- - constants: list[GsaConstant] | None, optional + constants: list[GsaSlimConstant] | None, optional """ - self._constants: list[GsaConstant] | None | Unset_Type = Unset + self._constants: list[GsaSlimConstant] | None | Unset_Type = Unset if constants is not Unset: self.constants = constants @property - def constants(self) -> "list[GsaConstant] | None | Unset_Type": + def constants(self) -> "list[GsaSlimConstant] | None | Unset_Type": """Gets the constants of this GsaConstantsInfo. Returns ------- - list[GsaConstant] | None | Unset_Type + list[GsaSlimConstant] | None | Unset_Type The constants of this GsaConstantsInfo. """ return self._constants @constants.setter - def constants(self, constants: "list[GsaConstant] | None | Unset_Type") -> None: + def constants(self, constants: "list[GsaSlimConstant] | None | Unset_Type") -> None: """Sets the constants of this GsaConstantsInfo. Parameters ---------- - constants: list[GsaConstant] | None | Unset_Type + constants: list[GsaSlimConstant] | None | Unset_Type The constants of this GsaConstantsInfo. """ self._constants = constants diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_continuous_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_continuous_quality_system.py deleted file mode 100644 index f94fdaf71..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_continuous_quality_system.py +++ /dev/null @@ -1,205 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_quality_system import ( # noqa: F401 - GsaQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaContinuousQualitySystem(GsaQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "does_quality_increase_with_value": "bool", - "guid": "str", - "name": "str", - "threshold_value": "float", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "does_quality_increase_with_value": "doesQualityIncreaseWithValue", - "guid": "guid", - "name": "name", - "threshold_value": "thresholdValue", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - does_quality_increase_with_value: "bool", - guid: "str", - name: "str", - threshold_value: "float", - type: "GsaQualitySystemType" = GsaQualitySystemType.CONTINUOUS, - ) -> None: - """GsaContinuousQualitySystem - a model defined in Swagger - - Parameters - ---------- - does_quality_increase_with_value: bool - guid: str - name: str - threshold_value: float - type: GsaQualitySystemType - """ - super().__init__(guid=guid, name=name, type=type) - self._does_quality_increase_with_value: bool - self._threshold_value: float - - self.does_quality_increase_with_value = does_quality_increase_with_value - self.threshold_value = threshold_value - - @property - def does_quality_increase_with_value(self) -> "bool": - """Gets the does_quality_increase_with_value of this GsaContinuousQualitySystem. - - Returns - ------- - bool - The does_quality_increase_with_value of this GsaContinuousQualitySystem. - """ - return self._does_quality_increase_with_value - - @does_quality_increase_with_value.setter - def does_quality_increase_with_value(self, does_quality_increase_with_value: "bool") -> None: - """Sets the does_quality_increase_with_value of this GsaContinuousQualitySystem. - - Parameters - ---------- - does_quality_increase_with_value: bool - The does_quality_increase_with_value of this GsaContinuousQualitySystem. - """ - # Field is not nullable - if does_quality_increase_with_value is None: - raise ValueError( - "Invalid value for 'does_quality_increase_with_value', must not be 'None'" - ) - # Field is required - if does_quality_increase_with_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'does_quality_increase_with_value', must not be 'Unset'" - ) - self._does_quality_increase_with_value = does_quality_increase_with_value - - @property - def threshold_value(self) -> "float": - """Gets the threshold_value of this GsaContinuousQualitySystem. - - Returns - ------- - float - The threshold_value of this GsaContinuousQualitySystem. - """ - return self._threshold_value - - @threshold_value.setter - def threshold_value(self, threshold_value: "float") -> None: - """Sets the threshold_value of this GsaContinuousQualitySystem. - - Parameters - ---------- - threshold_value: float - The threshold_value of this GsaContinuousQualitySystem. - """ - # Field is not nullable - if threshold_value is None: - raise ValueError("Invalid value for 'threshold_value', must not be 'None'") - # Field is required - if threshold_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'threshold_value', must not be 'Unset'") - self._threshold_value = threshold_value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaContinuousQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category.py deleted file mode 100644 index b095eda66..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category.py +++ /dev/null @@ -1,251 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type": "GsaSlimEntity", - "name": "str", - "guid": "str", - "table_mappings": "list[GsaCreateAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "discrete_type": "discreteType", - "name": "name", - "guid": "guid", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "discreteType": "GsaSlimEntity", - "tableMappings": "GsaCreateAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type: "GsaSlimEntity", - name: "str", - guid: "str | Unset_Type" = Unset, - table_mappings: "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - discrete_type: GsaSlimEntity - name: str - guid: str, optional - table_mappings: list[GsaCreateAccessControlCategoryTableMapping] | None, optional - """ - self._discrete_type: GsaSlimEntity - self._table_mappings: ( - list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - ) = Unset - self._name: str - self._guid: str | Unset_Type = Unset - - self.discrete_type = discrete_type - if table_mappings is not Unset: - self.table_mappings = table_mappings - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def discrete_type(self) -> "GsaSlimEntity": - """Gets the discrete_type of this GsaCreateAccessControlCategory. - - Returns - ------- - GsaSlimEntity - The discrete_type of this GsaCreateAccessControlCategory. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaSlimEntity") -> None: - """Sets the discrete_type of this GsaCreateAccessControlCategory. - - Parameters - ---------- - discrete_type: GsaSlimEntity - The discrete_type of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - # Field is required - if discrete_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type', must not be 'Unset'") - self._discrete_type = discrete_type - - @property - def table_mappings( - self, - ) -> "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type": - """Gets the table_mappings of this GsaCreateAccessControlCategory. - - Returns - ------- - list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaCreateAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaCreateAccessControlCategory. - - Parameters - ---------- - table_mappings: list[GsaCreateAccessControlCategoryTableMapping] | None | Unset_Type - The table_mappings of this GsaCreateAccessControlCategory. - """ - self._table_mappings = table_mappings - - @property - def name(self) -> "str": - """Gets the name of this GsaCreateAccessControlCategory. - - Returns - ------- - str - The name of this GsaCreateAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreateAccessControlCategory. - - Parameters - ---------- - name: str - The name of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreateAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreateAccessControlCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreateAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category_table_mapping.py deleted file mode 100644 index 95f590ced..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_access_control_category_table_mapping.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "table": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "table": "table", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - table: "GsaSlimEntity", - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - table: GsaSlimEntity - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaCreateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaCreateAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaCreateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaCreateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaCreateAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaCreateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - The values applied to the table for this category. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaCreateAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_attribute.py index 6f0cd99cb..0cbbf8ab2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_attribute.py @@ -66,28 +66,23 @@ class GsaCreateAttribute(ModelBase): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { "type": "GsaAttributeType", "defaultThresholdType": "GsaAttributeThresholdType", - "metaAttributes": "GsaCreateAttribute", } discriminator_value_class_map = { @@ -116,11 +111,9 @@ def __init__( name: "str", type: "GsaAttributeType", default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateAttribute - a model defined in Swagger @@ -129,18 +122,14 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ self._type: GsaAttributeType self._default_threshold_type: GsaAttributeThresholdType | Unset_Type = Unset self._help_path: str | None | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset - self._meta_attributes: list[GsaCreateAttribute] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset @@ -151,10 +140,6 @@ def __init__( self.help_path = help_path if is_hidden_from_search_criteria is not Unset: self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - if meta_attributes is not Unset: - self.meta_attributes = meta_attributes - if display_names is not Unset: - self.display_names = display_names self.name = name if guid is not Unset: self.guid = guid @@ -262,54 +247,6 @@ def is_hidden_from_search_criteria( """ self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def meta_attributes(self) -> "list[GsaCreateAttribute] | None | Unset_Type": - """Gets the meta_attributes of this GsaCreateAttribute. - - Returns - ------- - list[GsaCreateAttribute] | None | Unset_Type - The meta_attributes of this GsaCreateAttribute. - """ - return self._meta_attributes - - @meta_attributes.setter - def meta_attributes( - self, meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" - ) -> None: - """Sets the meta_attributes of this GsaCreateAttribute. - - Parameters - ---------- - meta_attributes: list[GsaCreateAttribute] | None | Unset_Type - The meta_attributes of this GsaCreateAttribute. - """ - self._meta_attributes = meta_attributes - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaCreateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaCreateAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaCreateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaCreateAttribute. - """ - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaCreateAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_link_target.py deleted file mode 100644 index acc696a41..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_link_target.py +++ /dev/null @@ -1,178 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateCrossDatabaseLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - "database_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - "database_guid": "databaseGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - database_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreateCrossDatabaseLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - database_guid: str | None, optional - """ - self._database_guid: str | None | Unset_Type = Unset - self._table_guid: str - - if database_guid is not Unset: - self.database_guid = database_guid - self.table_guid = table_guid - - @property - def database_guid(self) -> "str | None | Unset_Type": - """Gets the database_guid of this GsaCreateCrossDatabaseLinkTarget. - If databaseGuid is set, the target will match any database with that Guid. If databaseGuid is not set, the target wil match the tableGuid in any database. - - Returns - ------- - str | None | Unset_Type - The database_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - return self._database_guid - - @database_guid.setter - def database_guid(self, database_guid: "str | None | Unset_Type") -> None: - """Sets the database_guid of this GsaCreateCrossDatabaseLinkTarget. - If databaseGuid is set, the target will match any database with that Guid. If databaseGuid is not set, the target wil match the tableGuid in any database. - - Parameters - ---------- - database_guid: str | None | Unset_Type - The database_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - self._database_guid = database_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateCrossDatabaseLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateCrossDatabaseLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateCrossDatabaseLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateCrossDatabaseLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_record_link_group.py index 81062d675..e81d87a3e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_cross_database_record_link_group.py @@ -68,7 +68,7 @@ class GsaCreateCrossDatabaseRecordLinkGroup(GsaCreateRecordLinkGroup): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaCreateCrossDatabaseLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -85,16 +85,14 @@ class GsaCreateCrossDatabaseRecordLinkGroup(GsaCreateRecordLinkGroup): "include_indirect_links": "includeIndirectLinks", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateCrossDatabaseLinkTarget", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaCreateCrossDatabaseLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, @@ -105,49 +103,21 @@ def __init__( Parameters ---------- - link_target: GsaCreateCrossDatabaseLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional include_indirect_links: bool, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateCrossDatabaseLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._include_indirect_links: bool | Unset_Type = Unset - self.link_target = link_target if include_indirect_links is not Unset: self.include_indirect_links = include_indirect_links - @property - def link_target(self) -> "GsaCreateCrossDatabaseLinkTarget": - """Gets the link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - - Returns - ------- - GsaCreateCrossDatabaseLinkTarget - The link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateCrossDatabaseLinkTarget") -> None: - """Sets the link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateCrossDatabaseLinkTarget - The link_target of this GsaCreateCrossDatabaseRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def include_indirect_links(self) -> "bool | Unset_Type": """Gets the include_indirect_links of this GsaCreateCrossDatabaseRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_date_time_attribute.py index dada57ed6..d32d91d5f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_date_time_attribute.py @@ -69,22 +69,18 @@ class GsaCreateDateTimeAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DATETIME, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDateTimeAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_attribute.py index dbfe584a8..28a3a4f75 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_attribute.py @@ -70,12 +70,10 @@ class GsaCreateDiscreteAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateDiscreteAttribute(GsaCreateAttribute): "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DISCRETE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._discrete_type: GsaSlimEntity self._is_multi_valued: bool | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_functional_attribute.py index 221bfc0c0..437d41d3e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_functional_attribute.py @@ -71,11 +71,9 @@ class GsaCreateDiscreteFunctionalAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -84,11 +82,9 @@ class GsaCreateDiscreteFunctionalAttribute(GsaCreateAttribute): "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -106,11 +102,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.DISCRETEFUNCTIONAL, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteFunctionalAttribute - a model defined in Swagger @@ -121,21 +115,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._discrete_type: GsaSlimEntity self._attribute_parameters: list[GsaCreateDiscreteFunctionalAttributeParameter] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_parameter.py index 44c2e6435..2cc6fa396 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_parameter.py @@ -71,6 +71,7 @@ class GsaCreateDiscreteParameter(GsaCreateParameter): "type": "GsaParameterType", "values": "list[GsaCreateDiscreteParameterValue]", "guid": "str", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -79,6 +80,7 @@ class GsaCreateDiscreteParameter(GsaCreateParameter): "type": "type", "values": "values", "guid": "guid", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -95,6 +97,7 @@ def __init__( type: "GsaParameterType" = GsaParameterType.DISCRETE, values: "list[GsaCreateDiscreteParameterValue]", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaCreateDiscreteParameter - a model defined in Swagger @@ -105,12 +108,14 @@ def __init__( type: GsaParameterType values: list[GsaCreateDiscreteParameterValue] guid: str, optional + help_path: str | None, optional """ super().__init__( default_parameter_value_index=default_parameter_value_index, name=name, type=type, guid=guid, + help_path=help_path, ) self._values: list[GsaCreateDiscreteParameterValue] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_type.py index e54ded0ea..080694892 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_discrete_type.py @@ -62,21 +62,17 @@ class GsaCreateDiscreteType(ModelBase): """ swagger_types: dict[str, str] = { "name": "str", - "discrete_values": "list[GsaDiscreteValuesCreateDiscreteValue]", "guid": "str", "is_ordered": "bool", } attribute_map: dict[str, str] = { "name": "name", - "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", } - subtype_mapping: dict[str, str] = { - "discreteValues": "GsaDiscreteValuesCreateDiscreteValue", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -84,7 +80,6 @@ def __init__( self, *, name: "str", - discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_ordered: "bool | Unset_Type" = Unset, ) -> None: @@ -93,21 +88,15 @@ def __init__( Parameters ---------- name: str - discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None, optional guid: str, optional is_ordered: bool, optional """ self._is_ordered: bool | Unset_Type = Unset - self._discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type = ( - Unset - ) self._name: str self._guid: str | Unset_Type = Unset if is_ordered is not Unset: self.is_ordered = is_ordered - if discrete_values is not Unset: - self.discrete_values = discrete_values self.name = name if guid is not Unset: self.guid = guid @@ -137,30 +126,6 @@ def is_ordered(self, is_ordered: "bool | Unset_Type") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'None'") self._is_ordered = is_ordered - @property - def discrete_values(self) -> "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type": - """Gets the discrete_values of this GsaCreateDiscreteType. - - Returns - ------- - list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type - The discrete_values of this GsaCreateDiscreteType. - """ - return self._discrete_values - - @discrete_values.setter - def discrete_values( - self, discrete_values: "list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type" - ) -> None: - """Sets the discrete_values of this GsaCreateDiscreteType. - - Parameters - ---------- - discrete_values: list[GsaDiscreteValuesCreateDiscreteValue] | None | Unset_Type - The discrete_values of this GsaCreateDiscreteType. - """ - self._discrete_values = discrete_values - @property def name(self) -> "str": """Gets the name of this GsaCreateDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_dynamic_record_link_group.py similarity index 75% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_dynamic_record_link_group.py index caed13154..4fe2b9fe8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): +class GsaCreateDynamicRecordLinkGroup(GsaCreateRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -69,7 +69,7 @@ class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): """ swagger_types: dict[str, str] = { "attribute_pairs": "list[GsaCreateAttributeLinkPair]", - "link_target": "GsaCreateSmartLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -90,7 +90,6 @@ class GsaCreateSmartRecordLinkGroup(GsaCreateRecordLinkGroup): } subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateSmartLinkTarget", "referentialIntegrityModel": "GsaReferentialIntegrityModel", "attributePairs": "GsaCreateAttributeLinkPair", } @@ -101,20 +100,20 @@ def __init__( self, *, attribute_pairs: "list[GsaCreateAttributeLinkPair]", - link_target: "GsaCreateSmartLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, forbid_orphans: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" = Unset, ) -> None: - """GsaCreateSmartRecordLinkGroup - a model defined in Swagger + """GsaCreateDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] - link_target: GsaCreateSmartLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType @@ -122,66 +121,38 @@ def __init__( guid: str, optional referential_integrity_model: GsaReferentialIntegrityModel, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateSmartLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._forbid_orphans: bool | Unset_Type = Unset self._referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type = Unset self._attribute_pairs: list[GsaCreateAttributeLinkPair] - self.link_target = link_target if forbid_orphans is not Unset: self.forbid_orphans = forbid_orphans if referential_integrity_model is not Unset: self.referential_integrity_model = referential_integrity_model self.attribute_pairs = attribute_pairs - @property - def link_target(self) -> "GsaCreateSmartLinkTarget": - """Gets the link_target of this GsaCreateSmartRecordLinkGroup. - - Returns - ------- - GsaCreateSmartLinkTarget - The link_target of this GsaCreateSmartRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateSmartLinkTarget") -> None: - """Sets the link_target of this GsaCreateSmartRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateSmartLinkTarget - The link_target of this GsaCreateSmartRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def forbid_orphans(self) -> "bool | Unset_Type": - """Gets the forbid_orphans of this GsaCreateSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaCreateDynamicRecordLinkGroup. Returns ------- bool | Unset_Type - The forbid_orphans of this GsaCreateSmartRecordLinkGroup. + The forbid_orphans of this GsaCreateDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: - """Sets the forbid_orphans of this GsaCreateSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool | Unset_Type - The forbid_orphans of this GsaCreateSmartRecordLinkGroup. + The forbid_orphans of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -190,12 +161,12 @@ def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_Type": - """Gets the referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + The referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -203,12 +174,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_T def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" ) -> None: - """Sets the referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaCreateSmartRecordLinkGroup. + The referential_integrity_model of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -217,25 +188,23 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair]": - """Gets the attribute_pairs of this GsaCreateSmartRecordLinkGroup. - There must be at least one and not more than three attribute pairs. + """Gets the attribute_pairs of this GsaCreateDynamicRecordLinkGroup. Returns ------- list[GsaCreateAttributeLinkPair] - The attribute_pairs of this GsaCreateSmartRecordLinkGroup. + The attribute_pairs of this GsaCreateDynamicRecordLinkGroup. """ return self._attribute_pairs @attribute_pairs.setter def attribute_pairs(self, attribute_pairs: "list[GsaCreateAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaCreateSmartRecordLinkGroup. - There must be at least one and not more than three attribute pairs. + """Sets the attribute_pairs of this GsaCreateDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] - The attribute_pairs of this GsaCreateSmartRecordLinkGroup. + The attribute_pairs of this GsaCreateDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -267,7 +236,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateSmartRecordLinkGroup): + if not isinstance(other, GsaCreateDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_file_attribute.py index dd07a2646..aa24e4e7a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_file_attribute.py @@ -69,22 +69,18 @@ class GsaCreateFileAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.FILE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateFileAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_float_functional_attribute.py index 40d530976..609ede907 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_float_functional_attribute.py @@ -71,12 +71,10 @@ class GsaCreateFloatFunctionalAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_range": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -86,12 +84,10 @@ class GsaCreateFloatFunctionalAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_range": "isRange", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -111,12 +107,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.FLOATFUNCTIONAL, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_range: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateFloatFunctionalAttribute - a model defined in Swagger @@ -128,23 +122,19 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_range: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_hyperlink_attribute.py index 4a6fc1ea1..ed1947a8e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_hyperlink_attribute.py @@ -69,22 +69,18 @@ class GsaCreateHyperlinkAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.HYPERLINK, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateHyperlinkAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_integer_attribute.py index 4d05c91bc..131797e03 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_integer_attribute.py @@ -70,12 +70,10 @@ class GsaCreateIntegerAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_unique": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateIntegerAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_unique": "isUnique", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.INTEGER, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_unique: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateIntegerAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_unique: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_unique: bool | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout.py index 34b105d20..cb3cd7fbc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout.py @@ -64,19 +64,15 @@ class GsaCreateLayout(ModelBase): "name": "str", "applicable_applications": "list[str]", "guid": "str", - "sections": "list[GsaCreateLayoutSection]", } attribute_map: dict[str, str] = { "name": "name", "applicable_applications": "applicableApplications", "guid": "guid", - "sections": "sections", } - subtype_mapping: dict[str, str] = { - "sections": "GsaCreateLayoutSection", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -86,7 +82,6 @@ def __init__( name: "str", applicable_applications: "list[str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, - sections: "list[GsaCreateLayoutSection] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLayout - a model defined in Swagger @@ -95,17 +90,13 @@ def __init__( name: str applicable_applications: list[str] | None, optional guid: str, optional - sections: list[GsaCreateLayoutSection] | None, optional """ self._applicable_applications: list[str] | None | Unset_Type = Unset - self._sections: list[GsaCreateLayoutSection] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset if applicable_applications is not Unset: self.applicable_applications = applicable_applications - if sections is not Unset: - self.sections = sections self.name = name if guid is not Unset: self.guid = guid @@ -136,28 +127,6 @@ def applicable_applications( """ self._applicable_applications = applicable_applications - @property - def sections(self) -> "list[GsaCreateLayoutSection] | None | Unset_Type": - """Gets the sections of this GsaCreateLayout. - - Returns - ------- - list[GsaCreateLayoutSection] | None | Unset_Type - The sections of this GsaCreateLayout. - """ - return self._sections - - @sections.setter - def sections(self, sections: "list[GsaCreateLayoutSection] | None | Unset_Type") -> None: - """Sets the sections of this GsaCreateLayout. - - Parameters - ---------- - sections: list[GsaCreateLayoutSection] | None | Unset_Type - The sections of this GsaCreateLayout. - """ - self._sections = sections - @property def name(self) -> "str": """Gets the name of this GsaCreateLayout. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout_section.py index 172f7843c..6e2d93e86 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout_section.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_layout_section.py @@ -63,18 +63,14 @@ class GsaCreateLayoutSection(ModelBase): swagger_types: dict[str, str] = { "name": "str", "guid": "str", - "section_items": "list[GsaNewLayoutItem]", } attribute_map: dict[str, str] = { "name": "name", "guid": "guid", - "section_items": "sectionItems", } - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaNewLayoutItem", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, name: "str", guid: "str | Unset_Type" = Unset, - section_items: "list[GsaNewLayoutItem] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLayoutSection - a model defined in Swagger @@ -91,40 +86,14 @@ def __init__( ---------- name: str guid: str, optional - section_items: list[GsaNewLayoutItem] | None, optional """ - self._section_items: list[GsaNewLayoutItem] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset - if section_items is not Unset: - self.section_items = section_items self.name = name if guid is not Unset: self.guid = guid - @property - def section_items(self) -> "list[GsaNewLayoutItem] | None | Unset_Type": - """Gets the section_items of this GsaCreateLayoutSection. - - Returns - ------- - list[GsaNewLayoutItem] | None | Unset_Type - The section_items of this GsaCreateLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaNewLayoutItem] | None | Unset_Type") -> None: - """Sets the section_items of this GsaCreateLayoutSection. - - Parameters - ---------- - section_items: list[GsaNewLayoutItem] | None | Unset_Type - The section_items of this GsaCreateLayoutSection. - """ - self._section_items = section_items - @property def name(self) -> "str": """Gets the name of this GsaCreateLayoutSection. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_logical_attribute.py index 22266320e..fbc632d3e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_logical_attribute.py @@ -69,22 +69,18 @@ class GsaCreateLogicalAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.LOGICAL, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLogicalAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_long_text_attribute.py index 80d1aca73..43d2babe1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_long_text_attribute.py @@ -69,22 +69,18 @@ class GsaCreateLongTextAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.LONGTEXT, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateLongTextAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_maths_functional_attribute.py index 0bad83e1f..5e31aa687 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_maths_functional_attribute.py @@ -75,13 +75,11 @@ class GsaCreateMathsFunctionalAttribute(GsaCreateAttribute): "axis_name": "GsaCreateAxisName", "default_content": "GsaCreateMathsContent", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "expressions": "list[GsaSlimEntity]", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_range": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -95,13 +93,11 @@ class GsaCreateMathsFunctionalAttribute(GsaCreateAttribute): "axis_name": "axisName", "default_content": "defaultContent", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "expressions": "expressions", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_range": "isRange", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -127,13 +123,11 @@ def __init__( axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_content: "GsaCreateMathsContent | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_range: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateMathsFunctionalAttribute - a model defined in Swagger @@ -149,24 +143,20 @@ def __init__( axis_name: GsaCreateAxisName, optional default_content: GsaCreateMathsContent, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional expressions: list[GsaSlimEntity] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_range: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._attribute_parameters: list[GsaSlimEntity] | None | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_numeric_parameter.py index 9fae648b5..fe83d7e5a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_numeric_parameter.py @@ -74,6 +74,7 @@ class GsaCreateNumericParameter(GsaCreateParameter): "type": "GsaParameterType", "values": "list[GsaCreateNumericParameterValue]", "guid": "str", + "help_path": "str", "unit": "GsaSlimEntity", } @@ -86,6 +87,7 @@ class GsaCreateNumericParameter(GsaCreateParameter): "type": "type", "values": "values", "guid": "guid", + "help_path": "helpPath", "unit": "unit", } @@ -109,6 +111,7 @@ def __init__( type: "GsaParameterType" = GsaParameterType.NUMERIC, values: "list[GsaCreateNumericParameterValue]", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateNumericParameter - a model defined in Swagger @@ -123,6 +126,7 @@ def __init__( type: GsaParameterType values: list[GsaCreateNumericParameterValue] guid: str, optional + help_path: str | None, optional unit: GsaSlimEntity, optional """ super().__init__( @@ -130,6 +134,7 @@ def __init__( name=name, type=type, guid=guid, + help_path=help_path, ) self._is_restricted: bool self._unit: GsaSlimEntity | Unset_Type = Unset @@ -200,7 +205,6 @@ def unit(self, unit: "GsaSlimEntity | Unset_Type") -> None: @property def values(self) -> "list[GsaCreateNumericParameterValue]": """Gets the values of this GsaCreateNumericParameter. - Numeric parameter values cannot be ordered - they are ordered by numeric value. Returns ------- @@ -212,7 +216,6 @@ def values(self) -> "list[GsaCreateNumericParameterValue]": @values.setter def values(self, values: "list[GsaCreateNumericParameterValue]") -> None: """Sets the values of this GsaCreateNumericParameter. - Numeric parameter values cannot be ordered - they are ordered by numeric value. Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_parameter.py index bfcc8b07d..0503ff636 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_parameter.py @@ -67,6 +67,7 @@ class GsaCreateParameter(ModelBase): "name": "str", "type": "GsaParameterType", "guid": "str", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -74,6 +75,7 @@ class GsaCreateParameter(ModelBase): "name": "name", "type": "type", "guid": "guid", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -94,6 +96,7 @@ def __init__( name: "str", type: "GsaParameterType", guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaCreateParameter - a model defined in Swagger @@ -103,13 +106,17 @@ def __init__( name: str type: GsaParameterType guid: str, optional + help_path: str | None, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_index: int self._name: str self._guid: str | Unset_Type = Unset self.type = type + if help_path is not Unset: + self.help_path = help_path self.default_parameter_value_index = default_parameter_value_index self.name = name if guid is not Unset: @@ -143,6 +150,28 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaCreateParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaCreateParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaCreateParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaCreateParameter. + """ + self._help_path = help_path + @property def default_parameter_value_index(self) -> "int": """Gets the default_parameter_value_index of this GsaCreateParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission.py deleted file mode 100644 index f40a379b1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission.py +++ /dev/null @@ -1,306 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "role": "str", - "description": "str", - "guid": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "role": "role", - "description": "description", - "guid": "guid", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - role: "str", - description: "str | None | Unset_Type" = Unset, - guid: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreatePermission - a model defined in Swagger - - Parameters - ---------- - name: str - role: str - description: str | None, optional - guid: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - self._role: str - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - self._name: str - self._guid: str | Unset_Type = Unset - - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def role(self) -> "str": - """Gets the role of this GsaCreatePermission. - - Returns - ------- - str - The role of this GsaCreatePermission. - """ - return self._role - - @role.setter - def role(self, role: "str") -> None: - """Sets the role of this GsaCreatePermission. - - Parameters - ---------- - role: str - The role of this GsaCreatePermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - # Field is required - if role is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'role', must not be 'Unset'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreatePermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaCreatePermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreatePermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaCreatePermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaCreatePermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaCreatePermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaCreatePermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaCreatePermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaCreatePermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaCreatePermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaCreatePermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaCreatePermission. - """ - self._unset_message = unset_message - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePermission. - - Returns - ------- - str - The name of this GsaCreatePermission. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePermission. - - Parameters - ---------- - name: str - The name of this GsaCreatePermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreatePermission. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreatePermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreatePermission. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreatePermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission_category.py deleted file mode 100644 index adc121c74..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_permission_category.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "permissions": "list[GsaCreatePermission]", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "permissions": "permissions", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaCreatePermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - permissions: "list[GsaCreatePermission]", - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaCreatePermissionCategory - a model defined in Swagger - - Parameters - ---------- - name: str - permissions: list[GsaCreatePermission] - guid: str, optional - """ - self._permissions: list[GsaCreatePermission] - self._name: str - self._guid: str | Unset_Type = Unset - - self.permissions = permissions - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def permissions(self) -> "list[GsaCreatePermission]": - """Gets the permissions of this GsaCreatePermissionCategory. - - Returns - ------- - list[GsaCreatePermission] - The permissions of this GsaCreatePermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaCreatePermission]") -> None: - """Sets the permissions of this GsaCreatePermissionCategory. - - Parameters - ---------- - permissions: list[GsaCreatePermission] - The permissions of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - # Field is required - if permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permissions', must not be 'Unset'") - self._permissions = permissions - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePermissionCategory. - - Returns - ------- - str - The name of this GsaCreatePermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePermissionCategory. - - Parameters - ---------- - name: str - The name of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaCreatePermissionCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaCreatePermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaCreatePermissionCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaCreatePermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_picture_attribute.py index b4c69de66..e3c468bd2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_picture_attribute.py @@ -69,22 +69,18 @@ class GsaCreatePictureAttribute(GsaCreateAttribute): "name": "str", "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { "name": "name", "type": "type", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = {} @@ -97,11 +93,9 @@ def __init__( name: "str", type: "GsaAttributeType" = GsaAttributeType.PICTURE, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreatePictureAttribute - a model defined in Swagger @@ -110,21 +104,17 @@ def __init__( name: str type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_point_attribute.py index 4964ed430..0bf5312e8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_point_attribute.py @@ -71,12 +71,10 @@ class GsaCreatePointAttribute(GsaCreateAttribute): "attribute_parameters": "list[GsaSlimEntity]", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -86,12 +84,10 @@ class GsaCreatePointAttribute(GsaCreateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -111,12 +107,10 @@ def __init__( attribute_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreatePointAttribute - a model defined in Swagger @@ -128,23 +122,19 @@ def __init__( attribute_parameters: list[GsaSlimEntity] | None, optional axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_multi_valued: bool | Unset_Type = Unset self._unit: GsaSlimEntity | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_layout_item.py deleted file mode 100644 index 1ed039e30..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_layout_item.py +++ /dev/null @@ -1,174 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_layout_item import ( # noqa: F401 - GsaPutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutLayoutItem(GsaPutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaNewLayoutItemType", - } - - discriminator_value_class_map = { - "attribute".lower(): "#/components/schemas/GsaAttributeCreatePutLayoutItem", - "recordLink".lower(): "#/components/schemas/GsaRecordLinkCreatePutLayoutItem", - "smartLink".lower(): "#/components/schemas/GsaSmartLinkCreatePutLayoutItem", - "crossDatabaseLink".lower(): "#/components/schemas/GsaCrossDatabaseLinkCreatePutLayoutItem", - "associationChain".lower(): "#/components/schemas/GsaAssociationChainCreatePutLayoutItem", - } - - discriminator: Optional[str] = "item_type" - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - type: GsaPutType - """ - super().__init__(type=type) - self._item_type: GsaNewLayoutItemType - - self.item_type = item_type - - @property - def item_type(self) -> "GsaNewLayoutItemType": - """Gets the item_type of this GsaCreatePutLayoutItem. - - Returns - ------- - GsaNewLayoutItemType - The item_type of this GsaCreatePutLayoutItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaNewLayoutItemType") -> None: - """Sets the item_type of this GsaCreatePutLayoutItem. - - Parameters - ---------- - item_type: GsaNewLayoutItemType - The item_type of this GsaCreatePutLayoutItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission.py deleted file mode 100644 index 4db8bf1c8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission.py +++ /dev/null @@ -1,284 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_permission import ( # noqa: F401 - GsaPutPermission, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutPermission(GsaPutPermission): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "role": "str", - "type": "GsaPutType", - "description": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "role": "role", - "type": "type", - "description": "description", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - role: "str", - type: "GsaPutType" = GsaPutType.CREATE, - description: "str | None | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCreatePutPermission - a model defined in Swagger - - Parameters - ---------- - name: str - role: str - type: GsaPutType - description: str | None, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - super().__init__(type=type) - self._name: str - self._role: str - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - - self.name = name - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePutPermission. - - Returns - ------- - str - The name of this GsaCreatePutPermission. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePutPermission. - - Parameters - ---------- - name: str - The name of this GsaCreatePutPermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def role(self) -> "str": - """Gets the role of this GsaCreatePutPermission. - - Returns - ------- - str - The role of this GsaCreatePutPermission. - """ - return self._role - - @role.setter - def role(self, role: "str") -> None: - """Sets the role of this GsaCreatePutPermission. - - Parameters - ---------- - role: str - The role of this GsaCreatePutPermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - # Field is required - if role is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'role', must not be 'Unset'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreatePutPermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaCreatePutPermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreatePutPermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaCreatePutPermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaCreatePutPermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaCreatePutPermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaCreatePutPermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaCreatePutPermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaCreatePutPermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaCreatePutPermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaCreatePutPermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaCreatePutPermission. - """ - self._unset_message = unset_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission_category.py deleted file mode 100644 index d056b5445..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_put_permission_category.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_permission_category import ( # noqa: F401 - GsaPutPermissionCategory, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreatePutPermissionCategory(GsaPutPermissionCategory): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "permissions": "list[GsaCreatePermission]", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "name": "name", - "permissions": "permissions", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaCreatePermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - permissions: "list[GsaCreatePermission]", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCreatePutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - name: str - permissions: list[GsaCreatePermission] - type: GsaPutType - """ - super().__init__(type=type) - self._name: str - self._permissions: list[GsaCreatePermission] - - self.name = name - self.permissions = permissions - - @property - def name(self) -> "str": - """Gets the name of this GsaCreatePutPermissionCategory. - - Returns - ------- - str - The name of this GsaCreatePutPermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreatePutPermissionCategory. - - Parameters - ---------- - name: str - The name of this GsaCreatePutPermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def permissions(self) -> "list[GsaCreatePermission]": - """Gets the permissions of this GsaCreatePutPermissionCategory. - - Returns - ------- - list[GsaCreatePermission] - The permissions of this GsaCreatePutPermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaCreatePermission]") -> None: - """Sets the permissions of this GsaCreatePutPermissionCategory. - - Parameters - ---------- - permissions: list[GsaCreatePermission] - The permissions of this GsaCreatePutPermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - # Field is required - if permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permissions', must not be 'Unset'") - self._permissions = permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreatePutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_range_attribute.py index f2b19b575..62d0e254c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_range_attribute.py @@ -70,11 +70,9 @@ class GsaCreateRangeAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "axis_name": "GsaCreateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "unit": "GsaSlimEntity", } @@ -83,11 +81,9 @@ class GsaCreateRangeAttribute(GsaCreateAttribute): "type": "type", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", "unit": "unit", } @@ -105,11 +101,9 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.RANGE, axis_name: "GsaCreateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, ) -> None: """GsaCreateRangeAttribute - a model defined in Swagger @@ -120,22 +114,18 @@ def __init__( type: GsaAttributeType axis_name: GsaCreateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional unit: GsaSlimEntity, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._unit: GsaSlimEntity | Unset_Type = Unset self._axis_name: GsaCreateAxisName | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_record_link_group.py index e7255108a..a73507915 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_record_link_group.py @@ -63,6 +63,7 @@ class GsaCreateRecordLinkGroup(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -70,6 +71,7 @@ class GsaCreateRecordLinkGroup(ModelBase): } attribute_map: dict[str, str] = { + "link_target": "linkTarget", "name": "name", "reverse_name": "reverseName", "type": "type", @@ -78,11 +80,12 @@ class GsaCreateRecordLinkGroup(ModelBase): subtype_mapping: dict[str, str] = { "type": "GsaRecordLinkGroupType", + "linkTarget": "GsaLinkTarget", } discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaCreateStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaCreateSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaCreateDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaCreateCrossDatabaseRecordLinkGroup", } @@ -91,6 +94,7 @@ class GsaCreateRecordLinkGroup(ModelBase): def __init__( self, *, + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType", @@ -100,17 +104,20 @@ def __init__( Parameters ---------- + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional """ self._type: GsaRecordLinkGroupType + self._link_target: GsaLinkTarget self._reverse_name: str self._name: str self._guid: str | Unset_Type = Unset self.type = type + self.link_target = link_target self.reverse_name = reverse_name self.name = name if guid is not Unset: @@ -144,6 +151,34 @@ def type(self, type: "GsaRecordLinkGroupType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def link_target(self) -> "GsaLinkTarget": + """Gets the link_target of this GsaCreateRecordLinkGroup. + + Returns + ------- + GsaLinkTarget + The link_target of this GsaCreateRecordLinkGroup. + """ + return self._link_target + + @link_target.setter + def link_target(self, link_target: "GsaLinkTarget") -> None: + """Sets the link_target of this GsaCreateRecordLinkGroup. + + Parameters + ---------- + link_target: GsaLinkTarget + The link_target of this GsaCreateRecordLinkGroup. + """ + # Field is not nullable + if link_target is None: + raise ValueError("Invalid value for 'link_target', must not be 'None'") + # Field is required + if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_target', must not be 'Unset'") + self._link_target = link_target + @property def reverse_name(self) -> "str": """Gets the reverse_name of this GsaCreateRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_search_request.py similarity index 63% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_filter.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_search_request.py index 9ce4a1fe9..8852ddc2e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_filter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaQueryLayoutSectionFilter(ModelBase): +class GsaCreateSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,17 +61,17 @@ class GsaQueryLayoutSectionFilter(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "name": "str", - "section_items": "GsaQueryLayoutItemFilter", + "detail": "GsaSearchDetail", + "search_config": "str", } attribute_map: dict[str, str] = { - "name": "name", - "section_items": "sectionItems", + "detail": "detail", + "search_config": "searchConfig", } subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItemFilter", + "detail": "GsaSearchDetail", } discriminator: Optional[str] = None @@ -79,70 +79,70 @@ class GsaQueryLayoutSectionFilter(ModelBase): def __init__( self, *, - name: "str | None | Unset_Type" = Unset, - section_items: "GsaQueryLayoutItemFilter | Unset_Type" = Unset, + detail: "GsaSearchDetail | Unset_Type" = Unset, + search_config: "str | None | Unset_Type" = Unset, ) -> None: - """GsaQueryLayoutSectionFilter - a model defined in Swagger + """GsaCreateSearchRequest - a model defined in Swagger Parameters ---------- - name: str | None, optional - section_items: GsaQueryLayoutItemFilter, optional + detail: GsaSearchDetail, optional + search_config: str | None, optional """ - self._name: str | None | Unset_Type = Unset - self._section_items: GsaQueryLayoutItemFilter | Unset_Type = Unset + self._search_config: str | None | Unset_Type = Unset + self._detail: GsaSearchDetail | Unset_Type = Unset - if name is not Unset: - self.name = name - if section_items is not Unset: - self.section_items = section_items + if search_config is not Unset: + self.search_config = search_config + if detail is not Unset: + self.detail = detail @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSectionFilter. + def search_config(self) -> "str | None | Unset_Type": + """Gets the search_config of this GsaCreateSearchRequest. Returns ------- str | None | Unset_Type - The name of this GsaQueryLayoutSectionFilter. + The search_config of this GsaCreateSearchRequest. """ - return self._name + return self._search_config - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSectionFilter. + @search_config.setter + def search_config(self, search_config: "str | None | Unset_Type") -> None: + """Sets the search_config of this GsaCreateSearchRequest. Parameters ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutSectionFilter. + search_config: str | None | Unset_Type + The search_config of this GsaCreateSearchRequest. """ - self._name = name + self._search_config = search_config @property - def section_items(self) -> "GsaQueryLayoutItemFilter | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSectionFilter. + def detail(self) -> "GsaSearchDetail | Unset_Type": + """Gets the detail of this GsaCreateSearchRequest. Returns ------- - GsaQueryLayoutItemFilter | Unset_Type - The section_items of this GsaQueryLayoutSectionFilter. + GsaSearchDetail | Unset_Type + The detail of this GsaCreateSearchRequest. """ - return self._section_items + return self._detail - @section_items.setter - def section_items(self, section_items: "GsaQueryLayoutItemFilter | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSectionFilter. + @detail.setter + def detail(self, detail: "GsaSearchDetail | Unset_Type") -> None: + """Sets the detail of this GsaCreateSearchRequest. Parameters ---------- - section_items: GsaQueryLayoutItemFilter | Unset_Type - The section_items of this GsaQueryLayoutSectionFilter. + detail: GsaSearchDetail | Unset_Type + The detail of this GsaCreateSearchRequest. """ # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items + if detail is None: + raise ValueError("Invalid value for 'detail', must not be 'None'") + self._detail = detail @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -166,7 +166,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionFilter): + if not isinstance(other, GsaCreateSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_short_text_attribute.py index cb2e4bad2..5226c0b6b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_short_text_attribute.py @@ -70,12 +70,10 @@ class GsaCreateShortTextAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "data_rule": "GsaSlimEntity", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", "is_unique": "bool", - "meta_attributes": "list[GsaCreateAttribute]", } attribute_map: dict[str, str] = { @@ -83,12 +81,10 @@ class GsaCreateShortTextAttribute(GsaCreateAttribute): "type": "type", "data_rule": "dataRule", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_unique": "isUnique", - "meta_attributes": "metaAttributes", } subtype_mapping: dict[str, str] = { @@ -104,12 +100,10 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.SHORTTEXT, data_rule: "GsaSlimEntity | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_unique: "bool | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, ) -> None: """GsaCreateShortTextAttribute - a model defined in Swagger @@ -119,22 +113,18 @@ def __init__( type: GsaAttributeType data_rule: GsaSlimEntity, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional is_unique: bool, optional - meta_attributes: list[GsaCreateAttribute] | None, optional """ super().__init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._is_unique: bool | Unset_Type = Unset self._data_rule: GsaSlimEntity | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_link_target.py deleted file mode 100644 index 51f75f61d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_smart_link_target.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateSmartLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - ) -> None: - """GsaCreateSmartLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - """ - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateSmartLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateSmartLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateSmartLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateSmartLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateSmartLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_link_target.py deleted file mode 100644 index 3410b29e9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_link_target.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCreateStaticLinkTarget(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - ) -> None: - """GsaCreateStaticLinkTarget - a model defined in Swagger - - Parameters - ---------- - table_guid: str - """ - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaCreateStaticLinkTarget. - - Returns - ------- - str - The table_guid of this GsaCreateStaticLinkTarget. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaCreateStaticLinkTarget. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaCreateStaticLinkTarget. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateStaticLinkTarget): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_record_link_group.py index 453fc3772..83d89376f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_static_record_link_group.py @@ -68,7 +68,7 @@ class GsaCreateStaticRecordLinkGroup(GsaCreateRecordLinkGroup): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaCreateStaticLinkTarget", + "link_target": "GsaLinkTarget", "name": "str", "reverse_name": "str", "type": "GsaRecordLinkGroupType", @@ -85,16 +85,14 @@ class GsaCreateStaticRecordLinkGroup(GsaCreateRecordLinkGroup): "include_indirect_links": "includeIndirectLinks", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaCreateStaticLinkTarget", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaCreateStaticLinkTarget", + link_target: "GsaLinkTarget", name: "str", reverse_name: "str", type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, @@ -105,49 +103,21 @@ def __init__( Parameters ---------- - link_target: GsaCreateStaticLinkTarget + link_target: GsaLinkTarget name: str reverse_name: str type: GsaRecordLinkGroupType guid: str, optional include_indirect_links: bool, optional """ - super().__init__(name=name, reverse_name=reverse_name, type=type, guid=guid) - self._link_target: GsaCreateStaticLinkTarget + super().__init__( + link_target=link_target, name=name, reverse_name=reverse_name, type=type, guid=guid + ) self._include_indirect_links: bool | Unset_Type = Unset - self.link_target = link_target if include_indirect_links is not Unset: self.include_indirect_links = include_indirect_links - @property - def link_target(self) -> "GsaCreateStaticLinkTarget": - """Gets the link_target of this GsaCreateStaticRecordLinkGroup. - - Returns - ------- - GsaCreateStaticLinkTarget - The link_target of this GsaCreateStaticRecordLinkGroup. - """ - return self._link_target - - @link_target.setter - def link_target(self, link_target: "GsaCreateStaticLinkTarget") -> None: - """Sets the link_target of this GsaCreateStaticRecordLinkGroup. - - Parameters - ---------- - link_target: GsaCreateStaticLinkTarget - The link_target of this GsaCreateStaticRecordLinkGroup. - """ - # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") - # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target - @property def include_indirect_links(self) -> "bool | Unset_Type": """Gets the include_indirect_links of this GsaCreateStaticRecordLinkGroup. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_table.py index c46e0705d..4f4382f8a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_table.py @@ -62,26 +62,16 @@ class GsaCreateTable(ModelBase): """ swagger_types: dict[str, str] = { "name": "str", - "datasheet_footer": "str", - "datasheet_header": "str", "guid": "str", "is_hidden_from_browse": "bool", "is_hidden_from_search": "bool", - "legal_disclaimer": "str", - "should_show_version_control_signatures": "bool", - "table_types": "list[str]", } attribute_map: dict[str, str] = { "name": "name", - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", "is_hidden_from_search": "isHiddenFromSearch", - "legal_disclaimer": "legalDisclaimer", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", - "table_types": "tableTypes", } subtype_mapping: dict[str, str] = {} @@ -92,36 +82,21 @@ def __init__( self, *, name: "str", - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_hidden_from_browse: "bool | Unset_Type" = Unset, is_hidden_from_search: "bool | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, - table_types: "list[str] | None | Unset_Type" = Unset, ) -> None: """GsaCreateTable - a model defined in Swagger Parameters ---------- name: str - datasheet_footer: str | None, optional - datasheet_header: str | None, optional guid: str, optional is_hidden_from_browse: bool, optional is_hidden_from_search: bool, optional - legal_disclaimer: str | None, optional - should_show_version_control_signatures: bool, optional - table_types: list[str] | None, optional """ self._is_hidden_from_browse: bool | Unset_Type = Unset self._is_hidden_from_search: bool | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._table_types: list[str] | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset @@ -129,16 +104,6 @@ def __init__( self.is_hidden_from_browse = is_hidden_from_browse if is_hidden_from_search is not Unset: self.is_hidden_from_search = is_hidden_from_search - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if table_types is not Unset: - self.table_types = table_types - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures self.name = name if guid is not Unset: self.guid = guid @@ -193,123 +158,6 @@ def is_hidden_from_search(self, is_hidden_from_search: "bool | Unset_Type") -> N raise ValueError("Invalid value for 'is_hidden_from_search', must not be 'None'") self._is_hidden_from_search = is_hidden_from_search - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaCreateTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaCreateTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaCreateTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaCreateTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaCreateTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaCreateTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaCreateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaCreateTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaCreateTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaCreateTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaCreateTable. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaCreateTable. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaCreateTable. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaCreateTable. - """ - self._table_types = table_types - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaCreateTable. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaCreateTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaCreateTable. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaCreateTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - @property def name(self) -> "str": """Gets the name of this GsaCreateTable. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_tabular_attribute.py index d924d89bd..b8d3bb462 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_tabular_attribute.py @@ -70,13 +70,11 @@ class GsaCreateTabularAttribute(GsaCreateAttribute): "type": "GsaAttributeType", "default_threshold_type": "GsaAttributeThresholdType", "display_full_table": "bool", - "display_names": "dict(str, str)", "display_summary_row_inline": "bool", "guid": "str", "help_path": "str", "hide_unlinked_rows": "bool", "is_hidden_from_search_criteria": "bool", - "meta_attributes": "list[GsaCreateAttribute]", "tabular_columns": "list[GsaCreateTabularColumn]", "target": "GsaTabularAttributeTarget", } @@ -86,13 +84,11 @@ class GsaCreateTabularAttribute(GsaCreateAttribute): "type": "type", "default_threshold_type": "defaultThresholdType", "display_full_table": "displayFullTable", - "display_names": "displayNames", "display_summary_row_inline": "displaySummaryRowInline", "guid": "guid", "help_path": "helpPath", "hide_unlinked_rows": "hideUnlinkedRows", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "meta_attributes": "metaAttributes", "tabular_columns": "tabularColumns", "target": "target", } @@ -111,13 +107,11 @@ def __init__( type: "GsaAttributeType" = GsaAttributeType.LINK, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, display_full_table: "bool | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, display_summary_row_inline: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, hide_unlinked_rows: "bool | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, - meta_attributes: "list[GsaCreateAttribute] | None | Unset_Type" = Unset, tabular_columns: "list[GsaCreateTabularColumn] | None | Unset_Type" = Unset, target: "GsaTabularAttributeTarget | Unset_Type" = Unset, ) -> None: @@ -129,13 +123,11 @@ def __init__( type: GsaAttributeType default_threshold_type: GsaAttributeThresholdType, optional display_full_table: bool, optional - display_names: dict[str, str] | None, optional display_summary_row_inline: bool, optional guid: str, optional help_path: str | None, optional hide_unlinked_rows: bool, optional is_hidden_from_search_criteria: bool | None, optional - meta_attributes: list[GsaCreateAttribute] | None, optional tabular_columns: list[GsaCreateTabularColumn] | None, optional target: GsaTabularAttributeTarget, optional """ @@ -143,11 +135,9 @@ def __init__( name=name, type=type, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - meta_attributes=meta_attributes, ) self._display_full_table: bool | Unset_Type = Unset self._display_summary_row_inline: bool | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_system.py index d32c8538e..697950034 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_system.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_system.py @@ -63,18 +63,14 @@ class GsaCreateUnitSystem(ModelBase): swagger_types: dict[str, str] = { "name": "str", "guid": "str", - "unit_mappings": "list[GsaCreateUnitMapping]", } attribute_map: dict[str, str] = { "name": "name", "guid": "guid", - "unit_mappings": "unitMappings", } - subtype_mapping: dict[str, str] = { - "unitMappings": "GsaCreateUnitMapping", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, name: "str", guid: "str | Unset_Type" = Unset, - unit_mappings: "list[GsaCreateUnitMapping] | None | Unset_Type" = Unset, ) -> None: """GsaCreateUnitSystem - a model defined in Swagger @@ -91,44 +86,14 @@ def __init__( ---------- name: str guid: str, optional - unit_mappings: list[GsaCreateUnitMapping] | None, optional """ - self._unit_mappings: list[GsaCreateUnitMapping] | None | Unset_Type = Unset self._name: str self._guid: str | Unset_Type = Unset - if unit_mappings is not Unset: - self.unit_mappings = unit_mappings self.name = name if guid is not Unset: self.guid = guid - @property - def unit_mappings(self) -> "list[GsaCreateUnitMapping] | None | Unset_Type": - """Gets the unit_mappings of this GsaCreateUnitSystem. - Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here. - - Returns - ------- - list[GsaCreateUnitMapping] | None | Unset_Type - The unit_mappings of this GsaCreateUnitSystem. - """ - return self._unit_mappings - - @unit_mappings.setter - def unit_mappings( - self, unit_mappings: "list[GsaCreateUnitMapping] | None | Unset_Type" - ) -> None: - """Sets the unit_mappings of this GsaCreateUnitSystem. - Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here. - - Parameters - ---------- - unit_mappings: list[GsaCreateUnitMapping] | None | Unset_Type - The unit_mappings of this GsaCreateUnitSystem. - """ - self._unit_mappings = unit_mappings - @property def name(self) -> "str": """Gets the name of this GsaCreateUnitSystem. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link.py deleted file mode 100644 index 8e91d872e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "include_indirect_links": "bool", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "include_indirect_links": "includeIndirectLinks", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - include_indirect_links: "bool", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.CROSSDATABASELINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - include_indirect_links: bool - link_info: GsaLinkInfo - name: str - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._include_indirect_links: bool - - self.include_indirect_links = include_indirect_links - - @property - def include_indirect_links(self) -> "bool": - """Gets the include_indirect_links of this GsaCrossDatabaseLink. - - Returns - ------- - bool - The include_indirect_links of this GsaCrossDatabaseLink. - """ - return self._include_indirect_links - - @include_indirect_links.setter - def include_indirect_links(self, include_indirect_links: "bool") -> None: - """Sets the include_indirect_links of this GsaCrossDatabaseLink. - - Parameters - ---------- - include_indirect_links: bool - The include_indirect_links of this GsaCrossDatabaseLink. - """ - # Field is not nullable - if include_indirect_links is None: - raise ValueError("Invalid value for 'include_indirect_links', must not be 'None'") - # Field is required - if include_indirect_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_indirect_links', must not be 'Unset'") - self._include_indirect_links = include_indirect_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link_create_put_layout_item.py deleted file mode 100644 index 22525c879..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_link_create_put_layout_item.py +++ /dev/null @@ -1,232 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "source_database_guid": "str", - "source_table_guid": "str", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "source_database_guid": "sourceDatabaseGuid", - "source_table_guid": "sourceTableGuid", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.CROSSDATABASELINK, - link_group_guid: "str", - source_database_guid: "str", - source_table_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - ) -> None: - """GsaCrossDatabaseLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - source_database_guid: str - source_table_guid: str - type: GsaPutType - """ - super().__init__(item_type=item_type, type=type) - self._source_database_guid: str - self._source_table_guid: str - self._link_group_guid: str - - self.source_database_guid = source_database_guid - self.source_table_guid = source_table_guid - self.link_group_guid = link_group_guid - - @property - def source_database_guid(self) -> "str": - """Gets the source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._source_database_guid - - @source_database_guid.setter - def source_database_guid(self, source_database_guid: "str") -> None: - """Sets the source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - source_database_guid: str - The source_database_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if source_database_guid is None: - raise ValueError("Invalid value for 'source_database_guid', must not be 'None'") - # Field is required - if source_database_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_database_guid', must not be 'Unset'") - self._source_database_guid = source_database_guid - - @property - def source_table_guid(self) -> "str": - """Gets the source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._source_table_guid - - @source_table_guid.setter - def source_table_guid(self, source_table_guid: "str") -> None: - """Sets the source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - source_table_guid: str - The source_table_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if source_table_guid is None: - raise ValueError("Invalid value for 'source_table_guid', must not be 'None'") - # Field is required - if source_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_table_guid', must not be 'Unset'") - self._source_table_guid = source_table_guid - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaCrossDatabaseLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link.py deleted file mode 100644 index 0d37558fc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link.py +++ /dev/null @@ -1,176 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_base import ( # noqa: F401 - GsaRecordLinkBase, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseRecordLink(GsaRecordLinkBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - "reverse_notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - "reverse_notes": "reverseNotes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - reverse_notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseRecordLink - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - reverse_notes: str | None, optional - """ - super().__init__( - guid=guid, - record_link_group_type=record_link_group_type, - source_record_history_guid=source_record_history_guid, - target_record_history_guid=target_record_history_guid, - notes=notes, - ) - self._reverse_notes: str | None | Unset_Type = Unset - - if reverse_notes is not Unset: - self.reverse_notes = reverse_notes - - @property - def reverse_notes(self) -> "str | None | Unset_Type": - """Gets the reverse_notes of this GsaCrossDatabaseRecordLink. - - Returns - ------- - str | None | Unset_Type - The reverse_notes of this GsaCrossDatabaseRecordLink. - """ - return self._reverse_notes - - @reverse_notes.setter - def reverse_notes(self, reverse_notes: "str | None | Unset_Type") -> None: - """Sets the reverse_notes of this GsaCrossDatabaseRecordLink. - - Parameters - ---------- - reverse_notes: str | None | Unset_Type - The reverse_notes of this GsaCrossDatabaseRecordLink. - """ - self._reverse_notes = reverse_notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link_result.py deleted file mode 100644 index 7fcff77f2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_cross_database_record_link_result.py +++ /dev/null @@ -1,192 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCrossDatabaseRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_database_key": "str", - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "linked_database_key": "linkedDatabaseKey", - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - linked_database_key: "str", - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.CROSSDATABASE, - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaCrossDatabaseRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_database_key: str - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - notes: str | None, optional - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._linked_database_key: str - self._notes: str | None | Unset_Type = Unset - - self.linked_database_key = linked_database_key - if notes is not Unset: - self.notes = notes - - @property - def linked_database_key(self) -> "str": - """Gets the linked_database_key of this GsaCrossDatabaseRecordLinkResult. - - Returns - ------- - str - The linked_database_key of this GsaCrossDatabaseRecordLinkResult. - """ - return self._linked_database_key - - @linked_database_key.setter - def linked_database_key(self, linked_database_key: "str") -> None: - """Sets the linked_database_key of this GsaCrossDatabaseRecordLinkResult. - - Parameters - ---------- - linked_database_key: str - The linked_database_key of this GsaCrossDatabaseRecordLinkResult. - """ - # Field is not nullable - if linked_database_key is None: - raise ValueError("Invalid value for 'linked_database_key', must not be 'None'") - # Field is required - if linked_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'linked_database_key', must not be 'Unset'") - self._linked_database_key = linked_database_key - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaCrossDatabaseRecordLinkResult. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaCrossDatabaseRecordLinkResult. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaCrossDatabaseRecordLinkResult. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaCrossDatabaseRecordLinkResult. - """ - self._notes = notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCrossDatabaseRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currencies_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currencies_info.py deleted file mode 100644 index 3e7fb0317..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currencies_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrenciesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "currencies": "list[GsaCurrency]", - } - - attribute_map: dict[str, str] = { - "currencies": "currencies", - } - - subtype_mapping: dict[str, str] = { - "currencies": "GsaCurrency", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - currencies: "list[GsaCurrency]", - ) -> None: - """GsaCurrenciesInfo - a model defined in Swagger - - Parameters - ---------- - currencies: list[GsaCurrency] - """ - self._currencies: list[GsaCurrency] - - self.currencies = currencies - - @property - def currencies(self) -> "list[GsaCurrency]": - """Gets the currencies of this GsaCurrenciesInfo. - - Returns - ------- - list[GsaCurrency] - The currencies of this GsaCurrenciesInfo. - """ - return self._currencies - - @currencies.setter - def currencies(self, currencies: "list[GsaCurrency]") -> None: - """Sets the currencies of this GsaCurrenciesInfo. - - Parameters - ---------- - currencies: list[GsaCurrency] - The currencies of this GsaCurrenciesInfo. - """ - # Field is not nullable - if currencies is None: - raise ValueError("Invalid value for 'currencies', must not be 'None'") - # Field is required - if currencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'currencies', must not be 'Unset'") - self._currencies = currencies - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrenciesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency.py deleted file mode 100644 index ed2f5199d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency.py +++ /dev/null @@ -1,221 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrency(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "str", - "factor": "float", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "factor": "factor", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "str", - factor: "float", - name: "str", - ) -> None: - """GsaCurrency - a model defined in Swagger - - Parameters - ---------- - code: str - factor: float - name: str - """ - self._code: str - self._name: str - self._factor: float - - self.code = code - self.name = name - self.factor = factor - - @property - def code(self) -> "str": - """Gets the code of this GsaCurrency. - The code of the currency. - - Returns - ------- - str - The code of this GsaCurrency. - """ - return self._code - - @code.setter - def code(self, code: "str") -> None: - """Sets the code of this GsaCurrency. - The code of the currency. - - Parameters - ---------- - code: str - The code of this GsaCurrency. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - # Field is required - if code is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'code', must not be 'Unset'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaCurrency. - The unique name of the currency. - - Returns - ------- - str - The name of this GsaCurrency. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCurrency. - The unique name of the currency. - - Parameters - ---------- - name: str - The name of this GsaCurrency. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def factor(self) -> "float": - """Gets the factor of this GsaCurrency. - The conversion factor of the currency. - - Returns - ------- - float - The factor of this GsaCurrency. - """ - return self._factor - - @factor.setter - def factor(self, factor: "float") -> None: - """Sets the factor of this GsaCurrency. - The conversion factor of the currency. - - Parameters - ---------- - factor: float - The factor of this GsaCurrency. - """ - # Field is not nullable - if factor is None: - raise ValueError("Invalid value for 'factor', must not be 'None'") - # Field is required - if factor is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'factor', must not be 'Unset'") - self._factor = factor - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrency): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_detail.py deleted file mode 100644 index fe1652495..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_detail.py +++ /dev/null @@ -1,201 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaCurrencyErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaCurrencyErrorReason", - } - - discriminator_value_class_map = { - "nameMissing".lower(): "#/components/schemas/GsaNameMissingCurrencyErrorDetail", - "duplicateName".lower(): "#/components/schemas/GsaDuplicateNameCurrencyErrorDetail", - "nameWhitespace".lower(): "#/components/schemas/GsaNameWhitespaceCurrencyErrorDetail", - "codeMissing".lower(): "#/components/schemas/GsaCodeMissingCurrencyErrorDetail", - "duplicateCode".lower(): "#/components/schemas/GsaDuplicateCodeCurrencyErrorDetail", - "codeWhitespace".lower(): "#/components/schemas/GsaCodeWhitespaceCurrencyErrorDetail", - "tooLongCode".lower(): "#/components/schemas/GsaTooLongCodeCurrencyErrorDetail", - "invalidExchangeRate".lower(): "#/components/schemas/GsaInvalidExchangeRateCurrencyErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason", - ) -> None: - """GsaCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - self._message: str - self._reason: GsaCurrencyErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaCurrencyErrorDetail. - - Returns - ------- - str - The message of this GsaCurrencyErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaCurrencyErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaCurrencyErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaCurrencyErrorReason": - """Gets the reason of this GsaCurrencyErrorDetail. - - Returns - ------- - GsaCurrencyErrorReason - The reason of this GsaCurrencyErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaCurrencyErrorReason") -> None: - """Sets the reason of this GsaCurrencyErrorDetail. - - Parameters - ---------- - reason: GsaCurrencyErrorReason - The reason of this GsaCurrencyErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_reason.py deleted file mode 100644 index 9c58e12a3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_currency_error_reason.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaCurrencyErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEMISSING = "nameMissing" - DUPLICATENAME = "duplicateName" - NAMEWHITESPACE = "nameWhitespace" - CODEMISSING = "codeMissing" - DUPLICATECODE = "duplicateCode" - CODEWHITESPACE = "codeWhitespace" - TOOLONGCODE = "tooLongCode" - INVALIDEXCHANGERATE = "invalidExchangeRate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_export_range.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_export_range.py index 2003ef4ff..d36cfe1de 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_export_range.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_export_range.py @@ -61,92 +61,147 @@ class GsaDataExportRange(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "high_endpoint": "GsaRangeEndpoint", - "low_endpoint": "GsaRangeEndpoint", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", } attribute_map: dict[str, str] = { - "high_endpoint": "highEndpoint", - "low_endpoint": "lowEndpoint", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", } - subtype_mapping: dict[str, str] = { - "highEndpoint": "GsaRangeEndpoint", - "lowEndpoint": "GsaRangeEndpoint", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, + high_value: "float | None | Unset_Type" = Unset, + high_value_is_inclusive: "bool | Unset_Type" = Unset, + low_value: "float | None | Unset_Type" = Unset, + low_value_is_inclusive: "bool | Unset_Type" = Unset, ) -> None: """GsaDataExportRange - a model defined in Swagger Parameters ---------- - high_endpoint: GsaRangeEndpoint, optional - low_endpoint: GsaRangeEndpoint, optional + high_value: float | None, optional + high_value_is_inclusive: bool, optional + low_value: float | None, optional + low_value_is_inclusive: bool, optional + """ + self._high_value: float | None | Unset_Type = Unset + self._low_value: float | None | Unset_Type = Unset + self._high_value_is_inclusive: bool | Unset_Type = Unset + self._low_value_is_inclusive: bool | Unset_Type = Unset + + if high_value is not Unset: + self.high_value = high_value + if low_value is not Unset: + self.low_value = low_value + if high_value_is_inclusive is not Unset: + self.high_value_is_inclusive = high_value_is_inclusive + if low_value_is_inclusive is not Unset: + self.low_value_is_inclusive = low_value_is_inclusive + + @property + def high_value(self) -> "float | None | Unset_Type": + """Gets the high_value of this GsaDataExportRange. + + Returns + ------- + float | None | Unset_Type + The high_value of this GsaDataExportRange. + """ + return self._high_value + + @high_value.setter + def high_value(self, high_value: "float | None | Unset_Type") -> None: + """Sets the high_value of this GsaDataExportRange. + + Parameters + ---------- + high_value: float | None | Unset_Type + The high_value of this GsaDataExportRange. """ - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._high_value = high_value + + @property + def low_value(self) -> "float | None | Unset_Type": + """Gets the low_value of this GsaDataExportRange. - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint + Returns + ------- + float | None | Unset_Type + The low_value of this GsaDataExportRange. + """ + return self._low_value + + @low_value.setter + def low_value(self, low_value: "float | None | Unset_Type") -> None: + """Sets the low_value of this GsaDataExportRange. + + Parameters + ---------- + low_value: float | None | Unset_Type + The low_value of this GsaDataExportRange. + """ + self._low_value = low_value @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaDataExportRange. + def high_value_is_inclusive(self) -> "bool | Unset_Type": + """Gets the high_value_is_inclusive of this GsaDataExportRange. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaDataExportRange. + bool | Unset_Type + The high_value_is_inclusive of this GsaDataExportRange. """ - return self._high_endpoint + return self._high_value_is_inclusive - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaDataExportRange. + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool | Unset_Type") -> None: + """Sets the high_value_is_inclusive of this GsaDataExportRange. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaDataExportRange. + high_value_is_inclusive: bool | Unset_Type + The high_value_is_inclusive of this GsaDataExportRange. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + self._high_value_is_inclusive = high_value_is_inclusive @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaDataExportRange. + def low_value_is_inclusive(self) -> "bool | Unset_Type": + """Gets the low_value_is_inclusive of this GsaDataExportRange. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaDataExportRange. + bool | Unset_Type + The low_value_is_inclusive of this GsaDataExportRange. """ - return self._low_endpoint + return self._low_value_is_inclusive - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaDataExportRange. + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool | Unset_Type") -> None: + """Sets the low_value_is_inclusive of this GsaDataExportRange. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaDataExportRange. + low_value_is_inclusive: bool | Unset_Type + The low_value_is_inclusive of this GsaDataExportRange. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + self._low_value_is_inclusive = low_value_is_inclusive @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_source.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_source.py deleted file mode 100644 index 3155b1ef2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_source.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataSource(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "value": "str", - } - - attribute_map: dict[str, str] = { - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - value: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDataSource - a model defined in Swagger - - Parameters - ---------- - value: str | None, optional - """ - self._value: str | None | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "str | None | Unset_Type": - """Gets the value of this GsaDataSource. - - Returns - ------- - str | None | Unset_Type - The value of this GsaDataSource. - """ - return self._value - - @value.setter - def value(self, value: "str | None | Unset_Type") -> None: - """Sets the value of this GsaDataSource. - - Parameters - ---------- - value: str | None | Unset_Type - The value of this GsaDataSource. - """ - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataSource): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update.py deleted file mode 100644 index e32978a76..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "header": "GsaDataUpdateHeader", - "token": "GsaDataUpdateToken", - "run_info": "GsaDataUpdateRunInfo", - } - - attribute_map: dict[str, str] = { - "header": "header", - "token": "token", - "run_info": "runInfo", - } - - subtype_mapping: dict[str, str] = { - "token": "GsaDataUpdateToken", - "header": "GsaDataUpdateHeader", - "runInfo": "GsaDataUpdateRunInfo", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - header: "GsaDataUpdateHeader", - token: "GsaDataUpdateToken", - run_info: "GsaDataUpdateRunInfo | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdate - a model defined in Swagger - - Parameters - ---------- - header: GsaDataUpdateHeader - token: GsaDataUpdateToken - run_info: GsaDataUpdateRunInfo, optional - """ - self._token: GsaDataUpdateToken - self._header: GsaDataUpdateHeader - self._run_info: GsaDataUpdateRunInfo | Unset_Type = Unset - - self.token = token - self.header = header - if run_info is not Unset: - self.run_info = run_info - - @property - def token(self) -> "GsaDataUpdateToken": - """Gets the token of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateToken - The token of this GsaDataUpdate. - """ - return self._token - - @token.setter - def token(self, token: "GsaDataUpdateToken") -> None: - """Sets the token of this GsaDataUpdate. - - Parameters - ---------- - token: GsaDataUpdateToken - The token of this GsaDataUpdate. - """ - # Field is not nullable - if token is None: - raise ValueError("Invalid value for 'token', must not be 'None'") - # Field is required - if token is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'token', must not be 'Unset'") - self._token = token - - @property - def header(self) -> "GsaDataUpdateHeader": - """Gets the header of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateHeader - The header of this GsaDataUpdate. - """ - return self._header - - @header.setter - def header(self, header: "GsaDataUpdateHeader") -> None: - """Sets the header of this GsaDataUpdate. - - Parameters - ---------- - header: GsaDataUpdateHeader - The header of this GsaDataUpdate. - """ - # Field is not nullable - if header is None: - raise ValueError("Invalid value for 'header', must not be 'None'") - # Field is required - if header is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'header', must not be 'Unset'") - self._header = header - - @property - def run_info(self) -> "GsaDataUpdateRunInfo | Unset_Type": - """Gets the run_info of this GsaDataUpdate. - - Returns - ------- - GsaDataUpdateRunInfo | Unset_Type - The run_info of this GsaDataUpdate. - """ - return self._run_info - - @run_info.setter - def run_info(self, run_info: "GsaDataUpdateRunInfo | Unset_Type") -> None: - """Sets the run_info of this GsaDataUpdate. - - Parameters - ---------- - run_info: GsaDataUpdateRunInfo | Unset_Type - The run_info of this GsaDataUpdate. - """ - # Field is not nullable - if run_info is None: - raise ValueError("Invalid value for 'run_info', must not be 'None'") - self._run_info = run_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_header.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_header.py deleted file mode 100644 index ed654e3f3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_header.py +++ /dev/null @@ -1,622 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateHeader(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "contains_fallback_identifiers": "bool", - "create_date": "datetime", - "name": "str", - "project_guid": "str", - "source_volume_guid": "str", - "supported_objects_version": "int", - "update_format_version": "int", - "update_guid": "str", - "description": "str", - "mi_version": "str", - "new_version_guid": "str", - "prerequisite_update_guid": "str", - "prerequisite_update_name": "str", - "project_name": "str", - "source_database_key": "str", - } - - attribute_map: dict[str, str] = { - "contains_fallback_identifiers": "containsFallbackIdentifiers", - "create_date": "createDate", - "name": "name", - "project_guid": "projectGuid", - "source_volume_guid": "sourceVolumeGuid", - "supported_objects_version": "supportedObjectsVersion", - "update_format_version": "updateFormatVersion", - "update_guid": "updateGuid", - "description": "description", - "mi_version": "miVersion", - "new_version_guid": "newVersionGuid", - "prerequisite_update_guid": "prerequisiteUpdateGuid", - "prerequisite_update_name": "prerequisiteUpdateName", - "project_name": "projectName", - "source_database_key": "sourceDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - contains_fallback_identifiers: "bool", - create_date: "datetime", - name: "str", - project_guid: "str", - source_volume_guid: "str", - supported_objects_version: "int", - update_format_version: "int", - update_guid: "str", - description: "str | None | Unset_Type" = Unset, - mi_version: "str | None | Unset_Type" = Unset, - new_version_guid: "str | None | Unset_Type" = Unset, - prerequisite_update_guid: "str | None | Unset_Type" = Unset, - prerequisite_update_name: "str | None | Unset_Type" = Unset, - project_name: "str | None | Unset_Type" = Unset, - source_database_key: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdateHeader - a model defined in Swagger - - Parameters - ---------- - contains_fallback_identifiers: bool - create_date: datetime - name: str - project_guid: str - source_volume_guid: str - supported_objects_version: int - update_format_version: int - update_guid: str - description: str | None, optional - mi_version: str | None, optional - new_version_guid: str | None, optional - prerequisite_update_guid: str | None, optional - prerequisite_update_name: str | None, optional - project_name: str | None, optional - source_database_key: str | None, optional - """ - self._create_date: datetime - self._update_guid: str - self._prerequisite_update_guid: str | None | Unset_Type = Unset - self._prerequisite_update_name: str | None | Unset_Type = Unset - self._mi_version: str | None | Unset_Type = Unset - self._supported_objects_version: int - self._update_format_version: int - self._source_database_key: str | None | Unset_Type = Unset - self._source_volume_guid: str - self._name: str - self._description: str | None | Unset_Type = Unset - self._project_name: str | None | Unset_Type = Unset - self._project_guid: str - self._contains_fallback_identifiers: bool - self._new_version_guid: str | None | Unset_Type = Unset - - self.create_date = create_date - self.update_guid = update_guid - if prerequisite_update_guid is not Unset: - self.prerequisite_update_guid = prerequisite_update_guid - if prerequisite_update_name is not Unset: - self.prerequisite_update_name = prerequisite_update_name - if mi_version is not Unset: - self.mi_version = mi_version - self.supported_objects_version = supported_objects_version - self.update_format_version = update_format_version - if source_database_key is not Unset: - self.source_database_key = source_database_key - self.source_volume_guid = source_volume_guid - self.name = name - if description is not Unset: - self.description = description - if project_name is not Unset: - self.project_name = project_name - self.project_guid = project_guid - self.contains_fallback_identifiers = contains_fallback_identifiers - if new_version_guid is not Unset: - self.new_version_guid = new_version_guid - - @property - def create_date(self) -> "datetime": - """Gets the create_date of this GsaDataUpdateHeader. - The date and time that the update was created. - - Returns - ------- - datetime - The create_date of this GsaDataUpdateHeader. - """ - return self._create_date - - @create_date.setter - def create_date(self, create_date: "datetime") -> None: - """Sets the create_date of this GsaDataUpdateHeader. - The date and time that the update was created. - - Parameters - ---------- - create_date: datetime - The create_date of this GsaDataUpdateHeader. - """ - # Field is not nullable - if create_date is None: - raise ValueError("Invalid value for 'create_date', must not be 'None'") - # Field is required - if create_date is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'create_date', must not be 'Unset'") - self._create_date = create_date - - @property - def update_guid(self) -> "str": - """Gets the update_guid of this GsaDataUpdateHeader. - A unique identity to disambiguate this update from all other updates. - - Returns - ------- - str - The update_guid of this GsaDataUpdateHeader. - """ - return self._update_guid - - @update_guid.setter - def update_guid(self, update_guid: "str") -> None: - """Sets the update_guid of this GsaDataUpdateHeader. - A unique identity to disambiguate this update from all other updates. - - Parameters - ---------- - update_guid: str - The update_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if update_guid is None: - raise ValueError("Invalid value for 'update_guid', must not be 'None'") - # Field is required - if update_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_guid', must not be 'Unset'") - self._update_guid = update_guid - - @property - def prerequisite_update_guid(self) -> "str | None | Unset_Type": - """Gets the prerequisite_update_guid of this GsaDataUpdateHeader. - GUID for the previous update that need to have been applied before this update can be applied. - - Returns - ------- - str | None | Unset_Type - The prerequisite_update_guid of this GsaDataUpdateHeader. - """ - return self._prerequisite_update_guid - - @prerequisite_update_guid.setter - def prerequisite_update_guid(self, prerequisite_update_guid: "str | None | Unset_Type") -> None: - """Sets the prerequisite_update_guid of this GsaDataUpdateHeader. - GUID for the previous update that need to have been applied before this update can be applied. - - Parameters - ---------- - prerequisite_update_guid: str | None | Unset_Type - The prerequisite_update_guid of this GsaDataUpdateHeader. - """ - self._prerequisite_update_guid = prerequisite_update_guid - - @property - def prerequisite_update_name(self) -> "str | None | Unset_Type": - """Gets the prerequisite_update_name of this GsaDataUpdateHeader. - Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes. - - Returns - ------- - str | None | Unset_Type - The prerequisite_update_name of this GsaDataUpdateHeader. - """ - return self._prerequisite_update_name - - @prerequisite_update_name.setter - def prerequisite_update_name(self, prerequisite_update_name: "str | None | Unset_Type") -> None: - """Sets the prerequisite_update_name of this GsaDataUpdateHeader. - Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes. - - Parameters - ---------- - prerequisite_update_name: str | None | Unset_Type - The prerequisite_update_name of this GsaDataUpdateHeader. - """ - self._prerequisite_update_name = prerequisite_update_name - - @property - def mi_version(self) -> "str | None | Unset_Type": - """Gets the mi_version of this GsaDataUpdateHeader. - Gets the version of MI that was used to create this update. - - Returns - ------- - str | None | Unset_Type - The mi_version of this GsaDataUpdateHeader. - """ - return self._mi_version - - @mi_version.setter - def mi_version(self, mi_version: "str | None | Unset_Type") -> None: - """Sets the mi_version of this GsaDataUpdateHeader. - Gets the version of MI that was used to create this update. - - Parameters - ---------- - mi_version: str | None | Unset_Type - The mi_version of this GsaDataUpdateHeader. - """ - self._mi_version = mi_version - - @property - def supported_objects_version(self) -> "int": - """Gets the supported_objects_version of this GsaDataUpdateHeader. - Gets or sets the version number indicating the kinds of object that this update supports. A client will be able to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to ignore fields describing objects it does not recognise). - - Returns - ------- - int - The supported_objects_version of this GsaDataUpdateHeader. - """ - return self._supported_objects_version - - @supported_objects_version.setter - def supported_objects_version(self, supported_objects_version: "int") -> None: - """Sets the supported_objects_version of this GsaDataUpdateHeader. - Gets or sets the version number indicating the kinds of object that this update supports. A client will be able to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to ignore fields describing objects it does not recognise). - - Parameters - ---------- - supported_objects_version: int - The supported_objects_version of this GsaDataUpdateHeader. - """ - # Field is not nullable - if supported_objects_version is None: - raise ValueError("Invalid value for 'supported_objects_version', must not be 'None'") - # Field is required - if supported_objects_version is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'supported_objects_version', must not be 'Unset'") - self._supported_objects_version = supported_objects_version - - @property - def update_format_version(self) -> "int": - """Gets the update_format_version of this GsaDataUpdateHeader. - Gets or sets the version number of the format of the update. This will change if the meaning of any of the fields in the update changes. A client must not process an update with an UpdateFormatVersion field that it does not recognise, as it cannot be sure of the meaning of the fields it reads. - - Returns - ------- - int - The update_format_version of this GsaDataUpdateHeader. - """ - return self._update_format_version - - @update_format_version.setter - def update_format_version(self, update_format_version: "int") -> None: - """Sets the update_format_version of this GsaDataUpdateHeader. - Gets or sets the version number of the format of the update. This will change if the meaning of any of the fields in the update changes. A client must not process an update with an UpdateFormatVersion field that it does not recognise, as it cannot be sure of the meaning of the fields it reads. - - Parameters - ---------- - update_format_version: int - The update_format_version of this GsaDataUpdateHeader. - """ - # Field is not nullable - if update_format_version is None: - raise ValueError("Invalid value for 'update_format_version', must not be 'None'") - # Field is required - if update_format_version is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_format_version', must not be 'Unset'") - self._update_format_version = update_format_version - - @property - def source_database_key(self) -> "str | None | Unset_Type": - """Gets the source_database_key of this GsaDataUpdateHeader. - Gets or sets the database key of the database from which this update was generated. - - Returns - ------- - str | None | Unset_Type - The source_database_key of this GsaDataUpdateHeader. - """ - return self._source_database_key - - @source_database_key.setter - def source_database_key(self, source_database_key: "str | None | Unset_Type") -> None: - """Sets the source_database_key of this GsaDataUpdateHeader. - Gets or sets the database key of the database from which this update was generated. - - Parameters - ---------- - source_database_key: str | None | Unset_Type - The source_database_key of this GsaDataUpdateHeader. - """ - self._source_database_key = source_database_key - - @property - def source_volume_guid(self) -> "str": - """Gets the source_volume_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the volume from which the update was generated. - - Returns - ------- - str - The source_volume_guid of this GsaDataUpdateHeader. - """ - return self._source_volume_guid - - @source_volume_guid.setter - def source_volume_guid(self, source_volume_guid: "str") -> None: - """Sets the source_volume_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the volume from which the update was generated. - - Parameters - ---------- - source_volume_guid: str - The source_volume_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if source_volume_guid is None: - raise ValueError("Invalid value for 'source_volume_guid', must not be 'None'") - # Field is required - if source_volume_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_volume_guid', must not be 'Unset'") - self._source_volume_guid = source_volume_guid - - @property - def name(self) -> "str": - """Gets the name of this GsaDataUpdateHeader. - Gets or sets the name of the update. - - Returns - ------- - str - The name of this GsaDataUpdateHeader. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDataUpdateHeader. - Gets or sets the name of the update. - - Parameters - ---------- - name: str - The name of this GsaDataUpdateHeader. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaDataUpdateHeader. - Gets or sets the description of the update. - - Returns - ------- - str | None | Unset_Type - The description of this GsaDataUpdateHeader. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaDataUpdateHeader. - Gets or sets the description of the update. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaDataUpdateHeader. - """ - self._description = description - - @property - def project_name(self) -> "str | None | Unset_Type": - """Gets the project_name of this GsaDataUpdateHeader. - Gets or sets the name of the project this update was created for. - - Returns - ------- - str | None | Unset_Type - The project_name of this GsaDataUpdateHeader. - """ - return self._project_name - - @project_name.setter - def project_name(self, project_name: "str | None | Unset_Type") -> None: - """Sets the project_name of this GsaDataUpdateHeader. - Gets or sets the name of the project this update was created for. - - Parameters - ---------- - project_name: str | None | Unset_Type - The project_name of this GsaDataUpdateHeader. - """ - self._project_name = project_name - - @property - def project_guid(self) -> "str": - """Gets the project_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the project this update was created for. - - Returns - ------- - str - The project_guid of this GsaDataUpdateHeader. - """ - return self._project_guid - - @project_guid.setter - def project_guid(self, project_guid: "str") -> None: - """Sets the project_guid of this GsaDataUpdateHeader. - Gets or sets the guid of the project this update was created for. - - Parameters - ---------- - project_guid: str - The project_guid of this GsaDataUpdateHeader. - """ - # Field is not nullable - if project_guid is None: - raise ValueError("Invalid value for 'project_guid', must not be 'None'") - # Field is required - if project_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'project_guid', must not be 'Unset'") - self._project_guid = project_guid - - @property - def contains_fallback_identifiers(self) -> "bool": - """Gets the contains_fallback_identifiers of this GsaDataUpdateHeader. - Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names). - - Returns - ------- - bool - The contains_fallback_identifiers of this GsaDataUpdateHeader. - """ - return self._contains_fallback_identifiers - - @contains_fallback_identifiers.setter - def contains_fallback_identifiers(self, contains_fallback_identifiers: "bool") -> None: - """Sets the contains_fallback_identifiers of this GsaDataUpdateHeader. - Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names). - - Parameters - ---------- - contains_fallback_identifiers: bool - The contains_fallback_identifiers of this GsaDataUpdateHeader. - """ - # Field is not nullable - if contains_fallback_identifiers is None: - raise ValueError( - "Invalid value for 'contains_fallback_identifiers', must not be 'None'" - ) - # Field is required - if contains_fallback_identifiers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'contains_fallback_identifiers', must not be 'Unset'" - ) - self._contains_fallback_identifiers = contains_fallback_identifiers - - @property - def new_version_guid(self) -> "str | None | Unset_Type": - """Gets the new_version_guid of this GsaDataUpdateHeader. - Gets or sets the value Database Version GUID should be updated to. If this field is set then we propose to retarget tabular attributes to link to new version of the database. - - Returns - ------- - str | None | Unset_Type - The new_version_guid of this GsaDataUpdateHeader. - """ - return self._new_version_guid - - @new_version_guid.setter - def new_version_guid(self, new_version_guid: "str | None | Unset_Type") -> None: - """Sets the new_version_guid of this GsaDataUpdateHeader. - Gets or sets the value Database Version GUID should be updated to. If this field is set then we propose to retarget tabular attributes to link to new version of the database. - - Parameters - ---------- - new_version_guid: str | None | Unset_Type - The new_version_guid of this GsaDataUpdateHeader. - """ - self._new_version_guid = new_version_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateHeader): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_run_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_run_info.py deleted file mode 100644 index 3c8c3efcb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_run_info.py +++ /dev/null @@ -1,373 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdateRunInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_adds_as_state": "bool", - "database_key": "str", - "match_mode": "GsaMatchMode", - "retarget_tabular_attributes": "bool", - "status": "GsaUpdateRunStatus", - "applied_date": "datetime", - "error_message": "str", - "progress_percentage": "float", - } - - attribute_map: dict[str, str] = { - "apply_adds_as_state": "applyAddsAsState", - "database_key": "databaseKey", - "match_mode": "matchMode", - "retarget_tabular_attributes": "retargetTabularAttributes", - "status": "status", - "applied_date": "appliedDate", - "error_message": "errorMessage", - "progress_percentage": "progressPercentage", - } - - subtype_mapping: dict[str, str] = { - "matchMode": "GsaMatchMode", - "status": "GsaUpdateRunStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_adds_as_state: "bool", - database_key: "str", - match_mode: "GsaMatchMode", - retarget_tabular_attributes: "bool", - status: "GsaUpdateRunStatus", - applied_date: "datetime | None | Unset_Type" = Unset, - error_message: "str | None | Unset_Type" = Unset, - progress_percentage: "float | None | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdateRunInfo - a model defined in Swagger - - Parameters - ---------- - apply_adds_as_state: bool - database_key: str - match_mode: GsaMatchMode - retarget_tabular_attributes: bool - status: GsaUpdateRunStatus - applied_date: datetime | None, optional - error_message: str | None, optional - progress_percentage: float | None, optional - """ - self._database_key: str - self._match_mode: GsaMatchMode - self._apply_adds_as_state: bool - self._retarget_tabular_attributes: bool - self._status: GsaUpdateRunStatus - self._progress_percentage: float | None | Unset_Type = Unset - self._applied_date: datetime | None | Unset_Type = Unset - self._error_message: str | None | Unset_Type = Unset - - self.database_key = database_key - self.match_mode = match_mode - self.apply_adds_as_state = apply_adds_as_state - self.retarget_tabular_attributes = retarget_tabular_attributes - self.status = status - if progress_percentage is not Unset: - self.progress_percentage = progress_percentage - if applied_date is not Unset: - self.applied_date = applied_date - if error_message is not Unset: - self.error_message = error_message - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdateRunInfo. - - Returns - ------- - str - The database_key of this GsaDataUpdateRunInfo. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdateRunInfo. - - Parameters - ---------- - database_key: str - The database_key of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def match_mode(self) -> "GsaMatchMode": - """Gets the match_mode of this GsaDataUpdateRunInfo. - - Returns - ------- - GsaMatchMode - The match_mode of this GsaDataUpdateRunInfo. - """ - return self._match_mode - - @match_mode.setter - def match_mode(self, match_mode: "GsaMatchMode") -> None: - """Sets the match_mode of this GsaDataUpdateRunInfo. - - Parameters - ---------- - match_mode: GsaMatchMode - The match_mode of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if match_mode is None: - raise ValueError("Invalid value for 'match_mode', must not be 'None'") - # Field is required - if match_mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'match_mode', must not be 'Unset'") - self._match_mode = match_mode - - @property - def apply_adds_as_state(self) -> "bool": - """Gets the apply_adds_as_state of this GsaDataUpdateRunInfo. - - Returns - ------- - bool - The apply_adds_as_state of this GsaDataUpdateRunInfo. - """ - return self._apply_adds_as_state - - @apply_adds_as_state.setter - def apply_adds_as_state(self, apply_adds_as_state: "bool") -> None: - """Sets the apply_adds_as_state of this GsaDataUpdateRunInfo. - - Parameters - ---------- - apply_adds_as_state: bool - The apply_adds_as_state of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if apply_adds_as_state is None: - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'None'") - # Field is required - if apply_adds_as_state is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_adds_as_state', must not be 'Unset'") - self._apply_adds_as_state = apply_adds_as_state - - @property - def retarget_tabular_attributes(self) -> "bool": - """Gets the retarget_tabular_attributes of this GsaDataUpdateRunInfo. - - Returns - ------- - bool - The retarget_tabular_attributes of this GsaDataUpdateRunInfo. - """ - return self._retarget_tabular_attributes - - @retarget_tabular_attributes.setter - def retarget_tabular_attributes(self, retarget_tabular_attributes: "bool") -> None: - """Sets the retarget_tabular_attributes of this GsaDataUpdateRunInfo. - - Parameters - ---------- - retarget_tabular_attributes: bool - The retarget_tabular_attributes of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if retarget_tabular_attributes is None: - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'None'") - # Field is required - if retarget_tabular_attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'retarget_tabular_attributes', must not be 'Unset'") - self._retarget_tabular_attributes = retarget_tabular_attributes - - @property - def status(self) -> "GsaUpdateRunStatus": - """Gets the status of this GsaDataUpdateRunInfo. - - Returns - ------- - GsaUpdateRunStatus - The status of this GsaDataUpdateRunInfo. - """ - return self._status - - @status.setter - def status(self, status: "GsaUpdateRunStatus") -> None: - """Sets the status of this GsaDataUpdateRunInfo. - - Parameters - ---------- - status: GsaUpdateRunStatus - The status of this GsaDataUpdateRunInfo. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @property - def progress_percentage(self) -> "float | None | Unset_Type": - """Gets the progress_percentage of this GsaDataUpdateRunInfo. - - Returns - ------- - float | None | Unset_Type - The progress_percentage of this GsaDataUpdateRunInfo. - """ - return self._progress_percentage - - @progress_percentage.setter - def progress_percentage(self, progress_percentage: "float | None | Unset_Type") -> None: - """Sets the progress_percentage of this GsaDataUpdateRunInfo. - - Parameters - ---------- - progress_percentage: float | None | Unset_Type - The progress_percentage of this GsaDataUpdateRunInfo. - """ - self._progress_percentage = progress_percentage - - @property - def applied_date(self) -> "datetime | None | Unset_Type": - """Gets the applied_date of this GsaDataUpdateRunInfo. - - Returns - ------- - datetime | None | Unset_Type - The applied_date of this GsaDataUpdateRunInfo. - """ - return self._applied_date - - @applied_date.setter - def applied_date(self, applied_date: "datetime | None | Unset_Type") -> None: - """Sets the applied_date of this GsaDataUpdateRunInfo. - - Parameters - ---------- - applied_date: datetime | None | Unset_Type - The applied_date of this GsaDataUpdateRunInfo. - """ - self._applied_date = applied_date - - @property - def error_message(self) -> "str | None | Unset_Type": - """Gets the error_message of this GsaDataUpdateRunInfo. - - Returns - ------- - str | None | Unset_Type - The error_message of this GsaDataUpdateRunInfo. - """ - return self._error_message - - @error_message.setter - def error_message(self, error_message: "str | None | Unset_Type") -> None: - """Sets the error_message of this GsaDataUpdateRunInfo. - - Parameters - ---------- - error_message: str | None | Unset_Type - The error_message of this GsaDataUpdateRunInfo. - """ - self._error_message = error_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateRunInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job.py deleted file mode 100644 index 66d4b9057..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job.py +++ /dev/null @@ -1,480 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdaterJob(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "id": "str", - "job_type": "GsaDataUpdaterJobType", - "status": "GsaDataUpdaterJobStatus", - "time_started": "datetime", - "description": "str", - "error": "str", - "name": "str", - "project_name": "str", - "time_completed": "datetime", - "update_token": "GsaDataUpdateToken", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "id": "id", - "job_type": "jobType", - "status": "status", - "time_started": "timeStarted", - "description": "description", - "error": "error", - "name": "name", - "project_name": "projectName", - "time_completed": "timeCompleted", - "update_token": "updateToken", - } - - subtype_mapping: dict[str, str] = { - "updateToken": "GsaDataUpdateToken", - "jobType": "GsaDataUpdaterJobType", - "status": "GsaDataUpdaterJobStatus", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - id: "str", - job_type: "GsaDataUpdaterJobType", - status: "GsaDataUpdaterJobStatus", - time_started: "datetime", - description: "str | None | Unset_Type" = Unset, - error: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - project_name: "str | None | Unset_Type" = Unset, - time_completed: "datetime | None | Unset_Type" = Unset, - update_token: "GsaDataUpdateToken | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdaterJob - a model defined in Swagger - - Parameters - ---------- - database_key: str - id: str - job_type: GsaDataUpdaterJobType - status: GsaDataUpdaterJobStatus - time_started: datetime - description: str | None, optional - error: str | None, optional - name: str | None, optional - project_name: str | None, optional - time_completed: datetime | None, optional - update_token: GsaDataUpdateToken, optional - """ - self._id: str - self._update_token: GsaDataUpdateToken | Unset_Type = Unset - self._job_type: GsaDataUpdaterJobType - self._database_key: str - self._name: str | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._status: GsaDataUpdaterJobStatus - self._project_name: str | None | Unset_Type = Unset - self._time_started: datetime - self._time_completed: datetime | None | Unset_Type = Unset - self._error: str | None | Unset_Type = Unset - - self.id = id - if update_token is not Unset: - self.update_token = update_token - self.job_type = job_type - self.database_key = database_key - if name is not Unset: - self.name = name - if description is not Unset: - self.description = description - self.status = status - if project_name is not Unset: - self.project_name = project_name - self.time_started = time_started - if time_completed is not Unset: - self.time_completed = time_completed - if error is not Unset: - self.error = error - - @property - def id(self) -> "str": - """Gets the id of this GsaDataUpdaterJob. - Gets or sets the token which identifies this job. - - Returns - ------- - str - The id of this GsaDataUpdaterJob. - """ - return self._id - - @id.setter - def id(self, id: "str") -> None: - """Sets the id of this GsaDataUpdaterJob. - Gets or sets the token which identifies this job. - - Parameters - ---------- - id: str - The id of this GsaDataUpdaterJob. - """ - # Field is not nullable - if id is None: - raise ValueError("Invalid value for 'id', must not be 'None'") - # Field is required - if id is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'id', must not be 'Unset'") - self._id = id - - @property - def update_token(self) -> "GsaDataUpdateToken | Unset_Type": - """Gets the update_token of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdateToken | Unset_Type - The update_token of this GsaDataUpdaterJob. - """ - return self._update_token - - @update_token.setter - def update_token(self, update_token: "GsaDataUpdateToken | Unset_Type") -> None: - """Sets the update_token of this GsaDataUpdaterJob. - - Parameters - ---------- - update_token: GsaDataUpdateToken | Unset_Type - The update_token of this GsaDataUpdaterJob. - """ - # Field is not nullable - if update_token is None: - raise ValueError("Invalid value for 'update_token', must not be 'None'") - self._update_token = update_token - - @property - def job_type(self) -> "GsaDataUpdaterJobType": - """Gets the job_type of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdaterJobType - The job_type of this GsaDataUpdaterJob. - """ - return self._job_type - - @job_type.setter - def job_type(self, job_type: "GsaDataUpdaterJobType") -> None: - """Sets the job_type of this GsaDataUpdaterJob. - - Parameters - ---------- - job_type: GsaDataUpdaterJobType - The job_type of this GsaDataUpdaterJob. - """ - # Field is not nullable - if job_type is None: - raise ValueError("Invalid value for 'job_type', must not be 'None'") - # Field is required - if job_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'job_type', must not be 'Unset'") - self._job_type = job_type - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdaterJob. - Gets or sets the key of the database against which this job has been / will be run. - - Returns - ------- - str - The database_key of this GsaDataUpdaterJob. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdaterJob. - Gets or sets the key of the database against which this job has been / will be run. - - Parameters - ---------- - database_key: str - The database_key of this GsaDataUpdaterJob. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDataUpdaterJob. - Gets or sets the name of the update. - - Returns - ------- - str | None | Unset_Type - The name of this GsaDataUpdaterJob. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDataUpdaterJob. - Gets or sets the name of the update. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaDataUpdaterJob. - """ - self._name = name - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaDataUpdaterJob. - Gets or sets the description of the job. - - Returns - ------- - str | None | Unset_Type - The description of this GsaDataUpdaterJob. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaDataUpdaterJob. - Gets or sets the description of the job. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaDataUpdaterJob. - """ - self._description = description - - @property - def status(self) -> "GsaDataUpdaterJobStatus": - """Gets the status of this GsaDataUpdaterJob. - - Returns - ------- - GsaDataUpdaterJobStatus - The status of this GsaDataUpdaterJob. - """ - return self._status - - @status.setter - def status(self, status: "GsaDataUpdaterJobStatus") -> None: - """Sets the status of this GsaDataUpdaterJob. - - Parameters - ---------- - status: GsaDataUpdaterJobStatus - The status of this GsaDataUpdaterJob. - """ - # Field is not nullable - if status is None: - raise ValueError("Invalid value for 'status', must not be 'None'") - # Field is required - if status is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'status', must not be 'Unset'") - self._status = status - - @property - def project_name(self) -> "str | None | Unset_Type": - """Gets the project_name of this GsaDataUpdaterJob. - Gets or sets the project. - - Returns - ------- - str | None | Unset_Type - The project_name of this GsaDataUpdaterJob. - """ - return self._project_name - - @project_name.setter - def project_name(self, project_name: "str | None | Unset_Type") -> None: - """Sets the project_name of this GsaDataUpdaterJob. - Gets or sets the project. - - Parameters - ---------- - project_name: str | None | Unset_Type - The project_name of this GsaDataUpdaterJob. - """ - self._project_name = project_name - - @property - def time_started(self) -> "datetime": - """Gets the time_started of this GsaDataUpdaterJob. - Gets or sets the time that the job started. - - Returns - ------- - datetime - The time_started of this GsaDataUpdaterJob. - """ - return self._time_started - - @time_started.setter - def time_started(self, time_started: "datetime") -> None: - """Sets the time_started of this GsaDataUpdaterJob. - Gets or sets the time that the job started. - - Parameters - ---------- - time_started: datetime - The time_started of this GsaDataUpdaterJob. - """ - # Field is not nullable - if time_started is None: - raise ValueError("Invalid value for 'time_started', must not be 'None'") - # Field is required - if time_started is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'time_started', must not be 'Unset'") - self._time_started = time_started - - @property - def time_completed(self) -> "datetime | None | Unset_Type": - """Gets the time_completed of this GsaDataUpdaterJob. - Gets or sets the time that the job completed. - - Returns - ------- - datetime | None | Unset_Type - The time_completed of this GsaDataUpdaterJob. - """ - return self._time_completed - - @time_completed.setter - def time_completed(self, time_completed: "datetime | None | Unset_Type") -> None: - """Sets the time_completed of this GsaDataUpdaterJob. - Gets or sets the time that the job completed. - - Parameters - ---------- - time_completed: datetime | None | Unset_Type - The time_completed of this GsaDataUpdaterJob. - """ - self._time_completed = time_completed - - @property - def error(self) -> "str | None | Unset_Type": - """Gets the error of this GsaDataUpdaterJob. - The error that occurred (if any) when the job was run. If the job has not yet been run, or if the job completed successfully, this will be null. - - Returns - ------- - str | None | Unset_Type - The error of this GsaDataUpdaterJob. - """ - return self._error - - @error.setter - def error(self, error: "str | None | Unset_Type") -> None: - """Sets the error of this GsaDataUpdaterJob. - The error that occurred (if any) when the job was run. If the job has not yet been run, or if the job completed successfully, this will be null. - - Parameters - ---------- - error: str | None | Unset_Type - The error of this GsaDataUpdaterJob. - """ - self._error = error - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdaterJob): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_status.py deleted file mode 100644 index ef1b391c2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_status.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDataUpdaterJobStatus(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "Unknown" - QUEUED = "Queued" - INPROGRESS = "InProgress" - COMPLETED = "Completed" - CANCELLED = "Cancelled" - CANCELLING = "Cancelling" - FAILED = "Failed" - NOTFOUND = "NotFound" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_type.py deleted file mode 100644 index bcd1e6451..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_job_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDataUpdaterJobType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOACTION = "NoAction" - CREATEUPDATE = "CreateUpdate" - SHIP = "Ship" - DRYRUNUPDATE = "DryRunUpdate" - APPLYUPDATE = "ApplyUpdate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_project.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_project.py deleted file mode 100644 index 63d7e5297..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_updater_project.py +++ /dev/null @@ -1,602 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDataUpdaterProject(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "include_db_dependencies": "bool", - "include_deselected_db_dependencies": "bool", - "include_foreign_category_items": "bool", - "name": "str", - "record_and_attribute_selection_type": "GsaRecordAndAttributeSelectionType", - "last_marked_ready_for_sending_at_revision": "int", - "last_marked_ready_for_sending_by_user_name": "str", - "last_update_file_name": "str", - "last_update_generated_by_user_name": "str", - "profile_id": "str", - "selection": "GsaSelection", - "time_last_update_generated": "datetime", - "time_last_update_marked_ready_for_sending": "datetime", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "include_db_dependencies": "includeDbDependencies", - "include_deselected_db_dependencies": "includeDeselectedDbDependencies", - "include_foreign_category_items": "includeForeignCategoryItems", - "name": "name", - "record_and_attribute_selection_type": "recordAndAttributeSelectionType", - "last_marked_ready_for_sending_at_revision": "lastMarkedReadyForSendingAtRevision", - "last_marked_ready_for_sending_by_user_name": "lastMarkedReadyForSendingByUserName", - "last_update_file_name": "lastUpdateFileName", - "last_update_generated_by_user_name": "lastUpdateGeneratedByUserName", - "profile_id": "profileId", - "selection": "selection", - "time_last_update_generated": "timeLastUpdateGenerated", - "time_last_update_marked_ready_for_sending": "timeLastUpdateMarkedReadyForSending", - } - - subtype_mapping: dict[str, str] = { - "recordAndAttributeSelectionType": "GsaRecordAndAttributeSelectionType", - "selection": "GsaSelection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - include_db_dependencies: "bool", - include_deselected_db_dependencies: "bool", - include_foreign_category_items: "bool", - name: "str", - record_and_attribute_selection_type: "GsaRecordAndAttributeSelectionType", - last_marked_ready_for_sending_at_revision: "int | Unset_Type" = Unset, - last_marked_ready_for_sending_by_user_name: "str | None | Unset_Type" = Unset, - last_update_file_name: "str | None | Unset_Type" = Unset, - last_update_generated_by_user_name: "str | None | Unset_Type" = Unset, - profile_id: "str | None | Unset_Type" = Unset, - selection: "GsaSelection | Unset_Type" = Unset, - time_last_update_generated: "datetime | Unset_Type" = Unset, - time_last_update_marked_ready_for_sending: "datetime | Unset_Type" = Unset, - ) -> None: - """GsaDataUpdaterProject - a model defined in Swagger - - Parameters - ---------- - guid: str - include_db_dependencies: bool - include_deselected_db_dependencies: bool - include_foreign_category_items: bool - name: str - record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - last_marked_ready_for_sending_at_revision: int, optional - last_marked_ready_for_sending_by_user_name: str | None, optional - last_update_file_name: str | None, optional - last_update_generated_by_user_name: str | None, optional - profile_id: str | None, optional - selection: GsaSelection, optional - time_last_update_generated: datetime, optional - time_last_update_marked_ready_for_sending: datetime, optional - """ - self._guid: str - self._name: str - self._record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - self._include_db_dependencies: bool - self._include_deselected_db_dependencies: bool - self._include_foreign_category_items: bool - self._last_update_file_name: str | None | Unset_Type = Unset - self._last_marked_ready_for_sending_by_user_name: str | None | Unset_Type = Unset - self._time_last_update_marked_ready_for_sending: datetime | Unset_Type = Unset - self._last_marked_ready_for_sending_at_revision: int | Unset_Type = Unset - self._last_update_generated_by_user_name: str | None | Unset_Type = Unset - self._time_last_update_generated: datetime | Unset_Type = Unset - self._profile_id: str | None | Unset_Type = Unset - self._selection: GsaSelection | Unset_Type = Unset - - self.guid = guid - self.name = name - self.record_and_attribute_selection_type = record_and_attribute_selection_type - self.include_db_dependencies = include_db_dependencies - self.include_deselected_db_dependencies = include_deselected_db_dependencies - self.include_foreign_category_items = include_foreign_category_items - if last_update_file_name is not Unset: - self.last_update_file_name = last_update_file_name - if last_marked_ready_for_sending_by_user_name is not Unset: - self.last_marked_ready_for_sending_by_user_name = ( - last_marked_ready_for_sending_by_user_name - ) - if time_last_update_marked_ready_for_sending is not Unset: - self.time_last_update_marked_ready_for_sending = ( - time_last_update_marked_ready_for_sending - ) - if last_marked_ready_for_sending_at_revision is not Unset: - self.last_marked_ready_for_sending_at_revision = ( - last_marked_ready_for_sending_at_revision - ) - if last_update_generated_by_user_name is not Unset: - self.last_update_generated_by_user_name = last_update_generated_by_user_name - if time_last_update_generated is not Unset: - self.time_last_update_generated = time_last_update_generated - if profile_id is not Unset: - self.profile_id = profile_id - if selection is not Unset: - self.selection = selection - - @property - def guid(self) -> "str": - """Gets the guid of this GsaDataUpdaterProject. - - Returns - ------- - str - The guid of this GsaDataUpdaterProject. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaDataUpdaterProject. - - Parameters - ---------- - guid: str - The guid of this GsaDataUpdaterProject. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str": - """Gets the name of this GsaDataUpdaterProject. - - Returns - ------- - str - The name of this GsaDataUpdaterProject. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaDataUpdaterProject. - - Parameters - ---------- - name: str - The name of this GsaDataUpdaterProject. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def record_and_attribute_selection_type(self) -> "GsaRecordAndAttributeSelectionType": - """Gets the record_and_attribute_selection_type of this GsaDataUpdaterProject. - - Returns - ------- - GsaRecordAndAttributeSelectionType - The record_and_attribute_selection_type of this GsaDataUpdaterProject. - """ - return self._record_and_attribute_selection_type - - @record_and_attribute_selection_type.setter - def record_and_attribute_selection_type( - self, record_and_attribute_selection_type: "GsaRecordAndAttributeSelectionType" - ) -> None: - """Sets the record_and_attribute_selection_type of this GsaDataUpdaterProject. - - Parameters - ---------- - record_and_attribute_selection_type: GsaRecordAndAttributeSelectionType - The record_and_attribute_selection_type of this GsaDataUpdaterProject. - """ - # Field is not nullable - if record_and_attribute_selection_type is None: - raise ValueError( - "Invalid value for 'record_and_attribute_selection_type', must not be 'None'" - ) - # Field is required - if record_and_attribute_selection_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'record_and_attribute_selection_type', must not be 'Unset'" - ) - self._record_and_attribute_selection_type = record_and_attribute_selection_type - - @property - def include_db_dependencies(self) -> "bool": - """Gets the include_db_dependencies of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_db_dependencies of this GsaDataUpdaterProject. - """ - return self._include_db_dependencies - - @include_db_dependencies.setter - def include_db_dependencies(self, include_db_dependencies: "bool") -> None: - """Sets the include_db_dependencies of this GsaDataUpdaterProject. - - Parameters - ---------- - include_db_dependencies: bool - The include_db_dependencies of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_db_dependencies is None: - raise ValueError("Invalid value for 'include_db_dependencies', must not be 'None'") - # Field is required - if include_db_dependencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_db_dependencies', must not be 'Unset'") - self._include_db_dependencies = include_db_dependencies - - @property - def include_deselected_db_dependencies(self) -> "bool": - """Gets the include_deselected_db_dependencies of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_deselected_db_dependencies of this GsaDataUpdaterProject. - """ - return self._include_deselected_db_dependencies - - @include_deselected_db_dependencies.setter - def include_deselected_db_dependencies( - self, include_deselected_db_dependencies: "bool" - ) -> None: - """Sets the include_deselected_db_dependencies of this GsaDataUpdaterProject. - - Parameters - ---------- - include_deselected_db_dependencies: bool - The include_deselected_db_dependencies of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_deselected_db_dependencies is None: - raise ValueError( - "Invalid value for 'include_deselected_db_dependencies', must not be 'None'" - ) - # Field is required - if include_deselected_db_dependencies is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'include_deselected_db_dependencies', must not be 'Unset'" - ) - self._include_deselected_db_dependencies = include_deselected_db_dependencies - - @property - def include_foreign_category_items(self) -> "bool": - """Gets the include_foreign_category_items of this GsaDataUpdaterProject. - - Returns - ------- - bool - The include_foreign_category_items of this GsaDataUpdaterProject. - """ - return self._include_foreign_category_items - - @include_foreign_category_items.setter - def include_foreign_category_items(self, include_foreign_category_items: "bool") -> None: - """Sets the include_foreign_category_items of this GsaDataUpdaterProject. - - Parameters - ---------- - include_foreign_category_items: bool - The include_foreign_category_items of this GsaDataUpdaterProject. - """ - # Field is not nullable - if include_foreign_category_items is None: - raise ValueError( - "Invalid value for 'include_foreign_category_items', must not be 'None'" - ) - # Field is required - if include_foreign_category_items is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'include_foreign_category_items', must not be 'Unset'" - ) - self._include_foreign_category_items = include_foreign_category_items - - @property - def last_update_file_name(self) -> "str | None | Unset_Type": - """Gets the last_update_file_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_update_file_name of this GsaDataUpdaterProject. - """ - return self._last_update_file_name - - @last_update_file_name.setter - def last_update_file_name(self, last_update_file_name: "str | None | Unset_Type") -> None: - """Sets the last_update_file_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_update_file_name: str | None | Unset_Type - The last_update_file_name of this GsaDataUpdaterProject. - """ - self._last_update_file_name = last_update_file_name - - @property - def last_marked_ready_for_sending_by_user_name(self) -> "str | None | Unset_Type": - """Gets the last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - """ - return self._last_marked_ready_for_sending_by_user_name - - @last_marked_ready_for_sending_by_user_name.setter - def last_marked_ready_for_sending_by_user_name( - self, last_marked_ready_for_sending_by_user_name: "str | None | Unset_Type" - ) -> None: - """Sets the last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_marked_ready_for_sending_by_user_name: str | None | Unset_Type - The last_marked_ready_for_sending_by_user_name of this GsaDataUpdaterProject. - """ - self._last_marked_ready_for_sending_by_user_name = ( - last_marked_ready_for_sending_by_user_name - ) - - @property - def time_last_update_marked_ready_for_sending(self) -> "datetime | Unset_Type": - """Gets the time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - - Returns - ------- - datetime | Unset_Type - The time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - """ - return self._time_last_update_marked_ready_for_sending - - @time_last_update_marked_ready_for_sending.setter - def time_last_update_marked_ready_for_sending( - self, time_last_update_marked_ready_for_sending: "datetime | Unset_Type" - ) -> None: - """Sets the time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - - Parameters - ---------- - time_last_update_marked_ready_for_sending: datetime | Unset_Type - The time_last_update_marked_ready_for_sending of this GsaDataUpdaterProject. - """ - # Field is not nullable - if time_last_update_marked_ready_for_sending is None: - raise ValueError( - "Invalid value for 'time_last_update_marked_ready_for_sending', must not be 'None'" - ) - self._time_last_update_marked_ready_for_sending = time_last_update_marked_ready_for_sending - - @property - def last_marked_ready_for_sending_at_revision(self) -> "int | Unset_Type": - """Gets the last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - - Returns - ------- - int | Unset_Type - The last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - """ - return self._last_marked_ready_for_sending_at_revision - - @last_marked_ready_for_sending_at_revision.setter - def last_marked_ready_for_sending_at_revision( - self, last_marked_ready_for_sending_at_revision: "int | Unset_Type" - ) -> None: - """Sets the last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - - Parameters - ---------- - last_marked_ready_for_sending_at_revision: int | Unset_Type - The last_marked_ready_for_sending_at_revision of this GsaDataUpdaterProject. - """ - # Field is not nullable - if last_marked_ready_for_sending_at_revision is None: - raise ValueError( - "Invalid value for 'last_marked_ready_for_sending_at_revision', must not be 'None'" - ) - self._last_marked_ready_for_sending_at_revision = last_marked_ready_for_sending_at_revision - - @property - def last_update_generated_by_user_name(self) -> "str | None | Unset_Type": - """Gets the last_update_generated_by_user_name of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The last_update_generated_by_user_name of this GsaDataUpdaterProject. - """ - return self._last_update_generated_by_user_name - - @last_update_generated_by_user_name.setter - def last_update_generated_by_user_name( - self, last_update_generated_by_user_name: "str | None | Unset_Type" - ) -> None: - """Sets the last_update_generated_by_user_name of this GsaDataUpdaterProject. - - Parameters - ---------- - last_update_generated_by_user_name: str | None | Unset_Type - The last_update_generated_by_user_name of this GsaDataUpdaterProject. - """ - self._last_update_generated_by_user_name = last_update_generated_by_user_name - - @property - def time_last_update_generated(self) -> "datetime | Unset_Type": - """Gets the time_last_update_generated of this GsaDataUpdaterProject. - - Returns - ------- - datetime | Unset_Type - The time_last_update_generated of this GsaDataUpdaterProject. - """ - return self._time_last_update_generated - - @time_last_update_generated.setter - def time_last_update_generated( - self, time_last_update_generated: "datetime | Unset_Type" - ) -> None: - """Sets the time_last_update_generated of this GsaDataUpdaterProject. - - Parameters - ---------- - time_last_update_generated: datetime | Unset_Type - The time_last_update_generated of this GsaDataUpdaterProject. - """ - # Field is not nullable - if time_last_update_generated is None: - raise ValueError("Invalid value for 'time_last_update_generated', must not be 'None'") - self._time_last_update_generated = time_last_update_generated - - @property - def profile_id(self) -> "str | None | Unset_Type": - """Gets the profile_id of this GsaDataUpdaterProject. - - Returns - ------- - str | None | Unset_Type - The profile_id of this GsaDataUpdaterProject. - """ - return self._profile_id - - @profile_id.setter - def profile_id(self, profile_id: "str | None | Unset_Type") -> None: - """Sets the profile_id of this GsaDataUpdaterProject. - - Parameters - ---------- - profile_id: str | None | Unset_Type - The profile_id of this GsaDataUpdaterProject. - """ - self._profile_id = profile_id - - @property - def selection(self) -> "GsaSelection | Unset_Type": - """Gets the selection of this GsaDataUpdaterProject. - - Returns - ------- - GsaSelection | Unset_Type - The selection of this GsaDataUpdaterProject. - """ - return self._selection - - @selection.setter - def selection(self, selection: "GsaSelection | Unset_Type") -> None: - """Sets the selection of this GsaDataUpdaterProject. - - Parameters - ---------- - selection: GsaSelection | Unset_Type - The selection of this GsaDataUpdaterProject. - """ - # Field is not nullable - if selection is None: - raise ValueError("Invalid value for 'selection', must not be 'None'") - self._selection = selection - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdaterProject): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database.py index e0ce3978a..ddbdc47d7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database.py @@ -65,19 +65,14 @@ class GsaDatabase(ModelBase): "is_read_only": "bool", "key": "str", "status": "GsaDatabaseStatus", - "user_capabilities": "GsaDatabaseUserCapabilities", "author": "str", "company": "str", - "configuration_details": "GsaConfigurationDetails", "currency_code": "str", - "default_table": "GsaSlimNamedEntity", "guid": "str", "index_in_sync": "bool", "index_out_of_date_duration": "str", "index_up_to_date": "bool", "is_access_controlled": "bool", - "is_implicit_profile_disabled": "bool", - "issues": "GsaDatabaseIssues", "name": "str", "notes": "str", "schema_version": "str", @@ -89,19 +84,14 @@ class GsaDatabase(ModelBase): "is_read_only": "isReadOnly", "key": "key", "status": "status", - "user_capabilities": "userCapabilities", "author": "author", "company": "company", - "configuration_details": "configurationDetails", "currency_code": "currencyCode", - "default_table": "defaultTable", "guid": "guid", "index_in_sync": "indexInSync", "index_out_of_date_duration": "indexOutOfDateDuration", "index_up_to_date": "indexUpToDate", "is_access_controlled": "isAccessControlled", - "is_implicit_profile_disabled": "isImplicitProfileDisabled", - "issues": "issues", "name": "name", "notes": "notes", "schema_version": "schemaVersion", @@ -109,11 +99,7 @@ class GsaDatabase(ModelBase): } subtype_mapping: dict[str, str] = { - "defaultTable": "GsaSlimNamedEntity", "status": "GsaDatabaseStatus", - "userCapabilities": "GsaDatabaseUserCapabilities", - "configurationDetails": "GsaConfigurationDetails", - "issues": "GsaDatabaseIssues", } discriminator: Optional[str] = None @@ -125,19 +111,14 @@ def __init__( is_read_only: "bool", key: "str", status: "GsaDatabaseStatus", - user_capabilities: "GsaDatabaseUserCapabilities", author: "str | None | Unset_Type" = Unset, company: "str | None | Unset_Type" = Unset, - configuration_details: "GsaConfigurationDetails | Unset_Type" = Unset, currency_code: "str | None | Unset_Type" = Unset, - default_table: "GsaSlimNamedEntity | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, index_in_sync: "bool | None | Unset_Type" = Unset, index_out_of_date_duration: "str | None | Unset_Type" = Unset, index_up_to_date: "bool | None | Unset_Type" = Unset, is_access_controlled: "bool | None | Unset_Type" = Unset, - is_implicit_profile_disabled: "bool | None | Unset_Type" = Unset, - issues: "GsaDatabaseIssues | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, notes: "str | None | Unset_Type" = Unset, schema_version: "str | None | Unset_Type" = Unset, @@ -151,19 +132,14 @@ def __init__( is_read_only: bool key: str status: GsaDatabaseStatus - user_capabilities: GsaDatabaseUserCapabilities author: str | None, optional company: str | None, optional - configuration_details: GsaConfigurationDetails, optional currency_code: str | None, optional - default_table: GsaSlimNamedEntity, optional guid: str | None, optional index_in_sync: bool | None, optional index_out_of_date_duration: str | None, optional index_up_to_date: bool | None, optional is_access_controlled: bool | None, optional - is_implicit_profile_disabled: bool | None, optional - issues: GsaDatabaseIssues, optional name: str | None, optional notes: str | None, optional schema_version: str | None, optional @@ -174,8 +150,6 @@ def __init__( self._notes: str | None | Unset_Type = Unset self._currency_code: str | None | Unset_Type = Unset self._is_access_controlled: bool | None | Unset_Type = Unset - self._is_implicit_profile_disabled: bool | None | Unset_Type = Unset - self._default_table: GsaSlimNamedEntity | Unset_Type = Unset self._key: str self._status: GsaDatabaseStatus self._is_read_only: bool @@ -187,9 +161,6 @@ def __init__( self._index_up_to_date: bool | None | Unset_Type = Unset self._index_out_of_date_duration: str | None | Unset_Type = Unset self._schema_version: str | None | Unset_Type = Unset - self._user_capabilities: GsaDatabaseUserCapabilities - self._configuration_details: GsaConfigurationDetails | Unset_Type = Unset - self._issues: GsaDatabaseIssues | Unset_Type = Unset if author is not Unset: self.author = author @@ -201,10 +172,6 @@ def __init__( self.currency_code = currency_code if is_access_controlled is not Unset: self.is_access_controlled = is_access_controlled - if is_implicit_profile_disabled is not Unset: - self.is_implicit_profile_disabled = is_implicit_profile_disabled - if default_table is not Unset: - self.default_table = default_table self.key = key self.status = status self.is_read_only = is_read_only @@ -223,11 +190,6 @@ def __init__( self.index_out_of_date_duration = index_out_of_date_duration if schema_version is not Unset: self.schema_version = schema_version - self.user_capabilities = user_capabilities - if configuration_details is not Unset: - self.configuration_details = configuration_details - if issues is not Unset: - self.issues = issues @property def author(self) -> "str | None | Unset_Type": @@ -339,57 +301,6 @@ def is_access_controlled(self, is_access_controlled: "bool | None | Unset_Type") """ self._is_access_controlled = is_access_controlled - @property - def is_implicit_profile_disabled(self) -> "bool | None | Unset_Type": - """Gets the is_implicit_profile_disabled of this GsaDatabase. - When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile. The implicit Profile for this database can be disabled by setting this flag. - - Returns - ------- - bool | None | Unset_Type - The is_implicit_profile_disabled of this GsaDatabase. - """ - return self._is_implicit_profile_disabled - - @is_implicit_profile_disabled.setter - def is_implicit_profile_disabled( - self, is_implicit_profile_disabled: "bool | None | Unset_Type" - ) -> None: - """Sets the is_implicit_profile_disabled of this GsaDatabase. - When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile. The implicit Profile for this database can be disabled by setting this flag. - - Parameters - ---------- - is_implicit_profile_disabled: bool | None | Unset_Type - The is_implicit_profile_disabled of this GsaDatabase. - """ - self._is_implicit_profile_disabled = is_implicit_profile_disabled - - @property - def default_table(self) -> "GsaSlimNamedEntity | Unset_Type": - """Gets the default_table of this GsaDatabase. - - Returns - ------- - GsaSlimNamedEntity | Unset_Type - The default_table of this GsaDatabase. - """ - return self._default_table - - @default_table.setter - def default_table(self, default_table: "GsaSlimNamedEntity | Unset_Type") -> None: - """Sets the default_table of this GsaDatabase. - - Parameters - ---------- - default_table: GsaSlimNamedEntity | Unset_Type - The default_table of this GsaDatabase. - """ - # Field is not nullable - if default_table is None: - raise ValueError("Invalid value for 'default_table', must not be 'None'") - self._default_table = default_table - @property def key(self) -> "str": """Gets the key of this GsaDatabase. @@ -658,86 +569,6 @@ def schema_version(self, schema_version: "str | None | Unset_Type") -> None: """ self._schema_version = schema_version - @property - def user_capabilities(self) -> "GsaDatabaseUserCapabilities": - """Gets the user_capabilities of this GsaDatabase. - - Returns - ------- - GsaDatabaseUserCapabilities - The user_capabilities of this GsaDatabase. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaDatabaseUserCapabilities") -> None: - """Sets the user_capabilities of this GsaDatabase. - - Parameters - ---------- - user_capabilities: GsaDatabaseUserCapabilities - The user_capabilities of this GsaDatabase. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @property - def configuration_details(self) -> "GsaConfigurationDetails | Unset_Type": - """Gets the configuration_details of this GsaDatabase. - - Returns - ------- - GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaDatabase. - """ - return self._configuration_details - - @configuration_details.setter - def configuration_details( - self, configuration_details: "GsaConfigurationDetails | Unset_Type" - ) -> None: - """Sets the configuration_details of this GsaDatabase. - - Parameters - ---------- - configuration_details: GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaDatabase. - """ - # Field is not nullable - if configuration_details is None: - raise ValueError("Invalid value for 'configuration_details', must not be 'None'") - self._configuration_details = configuration_details - - @property - def issues(self) -> "GsaDatabaseIssues | Unset_Type": - """Gets the issues of this GsaDatabase. - - Returns - ------- - GsaDatabaseIssues | Unset_Type - The issues of this GsaDatabase. - """ - return self._issues - - @issues.setter - def issues(self, issues: "GsaDatabaseIssues | Unset_Type") -> None: - """Sets the issues of this GsaDatabase. - - Parameters - ---------- - issues: GsaDatabaseIssues | Unset_Type - The issues of this GsaDatabase. - """ - # Field is not nullable - if issues is None: - raise ValueError("Invalid value for 'issues', must not be 'None'") - self._issues = issues - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_currency_unit_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_currency_unit_usage_data_modification_error_detail.py deleted file mode 100644 index 6d7912a77..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_currency_unit_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.DATABASECURRENCYUNIT, - ) -> None: - """GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_issues.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_issues.py deleted file mode 100644 index 80551399e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_issues.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseIssues(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_revision_identity_has_decreased": "bool", - "loading_exception_info": "GsaExceptionInformation", - } - - attribute_map: dict[str, str] = { - "database_revision_identity_has_decreased": "databaseRevisionIdentityHasDecreased", - "loading_exception_info": "loadingExceptionInfo", - } - - subtype_mapping: dict[str, str] = { - "loadingExceptionInfo": "GsaExceptionInformation", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_revision_identity_has_decreased: "bool", - loading_exception_info: "GsaExceptionInformation | Unset_Type" = Unset, - ) -> None: - """GsaDatabaseIssues - a model defined in Swagger - - Parameters - ---------- - database_revision_identity_has_decreased: bool - loading_exception_info: GsaExceptionInformation, optional - """ - self._database_revision_identity_has_decreased: bool - self._loading_exception_info: GsaExceptionInformation | Unset_Type = Unset - - self.database_revision_identity_has_decreased = database_revision_identity_has_decreased - if loading_exception_info is not Unset: - self.loading_exception_info = loading_exception_info - - @property - def database_revision_identity_has_decreased(self) -> "bool": - """Gets the database_revision_identity_has_decreased of this GsaDatabaseIssues. - - Returns - ------- - bool - The database_revision_identity_has_decreased of this GsaDatabaseIssues. - """ - return self._database_revision_identity_has_decreased - - @database_revision_identity_has_decreased.setter - def database_revision_identity_has_decreased( - self, database_revision_identity_has_decreased: "bool" - ) -> None: - """Sets the database_revision_identity_has_decreased of this GsaDatabaseIssues. - - Parameters - ---------- - database_revision_identity_has_decreased: bool - The database_revision_identity_has_decreased of this GsaDatabaseIssues. - """ - # Field is not nullable - if database_revision_identity_has_decreased is None: - raise ValueError( - "Invalid value for 'database_revision_identity_has_decreased', must not be 'None'" - ) - # Field is required - if database_revision_identity_has_decreased is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'database_revision_identity_has_decreased', must not be 'Unset'" - ) - self._database_revision_identity_has_decreased = database_revision_identity_has_decreased - - @property - def loading_exception_info(self) -> "GsaExceptionInformation | Unset_Type": - """Gets the loading_exception_info of this GsaDatabaseIssues. - - Returns - ------- - GsaExceptionInformation | Unset_Type - The loading_exception_info of this GsaDatabaseIssues. - """ - return self._loading_exception_info - - @loading_exception_info.setter - def loading_exception_info( - self, loading_exception_info: "GsaExceptionInformation | Unset_Type" - ) -> None: - """Sets the loading_exception_info of this GsaDatabaseIssues. - - Parameters - ---------- - loading_exception_info: GsaExceptionInformation | Unset_Type - The loading_exception_info of this GsaDatabaseIssues. - """ - # Field is not nullable - if loading_exception_info is None: - raise ValueError("Invalid value for 'loading_exception_info', must not be 'None'") - self._loading_exception_info = loading_exception_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseIssues): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups.py deleted file mode 100644 index f6c151d68..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups.py +++ /dev/null @@ -1,317 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "database_key": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "database_key": "databaseKey", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str", - database_key: "str", - grant_group: "str", - power_user_group: "str", - read_group: "str", - write_group: "str", - ) -> None: - """GsaDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str - database_key: str - grant_group: str - power_user_group: str - read_group: str - write_group: str - """ - self._database_key: str - self._admin_group: str - self._grant_group: str - self._power_user_group: str - self._write_group: str - self._read_group: str - - self.database_key = database_key - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The database_key of this GsaDatabaseSecurityGroups. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - database_key: str - The database_key of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def admin_group(self) -> "str": - """Gets the admin_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The admin_group of this GsaDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str") -> None: - """Sets the admin_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str - The admin_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str": - """Gets the grant_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The grant_group of this GsaDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str") -> None: - """Sets the grant_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str - The grant_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str": - """Gets the power_user_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The power_user_group of this GsaDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str") -> None: - """Sets the power_user_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str - The power_user_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str": - """Gets the write_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The write_group of this GsaDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str") -> None: - """Sets the write_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str - The write_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str": - """Gets the read_group of this GsaDatabaseSecurityGroups. - - Returns - ------- - str - The read_group of this GsaDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str") -> None: - """Sets the read_group of this GsaDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str - The read_group of this GsaDatabaseSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups_info.py deleted file mode 100644 index 5f950b802..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_security_groups_info.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseSecurityGroupsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_security_groups": "list[GsaDatabaseSecurityGroups]", - } - - attribute_map: dict[str, str] = { - "database_security_groups": "databaseSecurityGroups", - } - - subtype_mapping: dict[str, str] = { - "databaseSecurityGroups": "GsaDatabaseSecurityGroups", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_security_groups: "list[GsaDatabaseSecurityGroups]", - ) -> None: - """GsaDatabaseSecurityGroupsInfo - a model defined in Swagger - - Parameters - ---------- - database_security_groups: list[GsaDatabaseSecurityGroups] - """ - self._database_security_groups: list[GsaDatabaseSecurityGroups] - - self.database_security_groups = database_security_groups - - @property - def database_security_groups(self) -> "list[GsaDatabaseSecurityGroups]": - """Gets the database_security_groups of this GsaDatabaseSecurityGroupsInfo. - - Returns - ------- - list[GsaDatabaseSecurityGroups] - The database_security_groups of this GsaDatabaseSecurityGroupsInfo. - """ - return self._database_security_groups - - @database_security_groups.setter - def database_security_groups( - self, database_security_groups: "list[GsaDatabaseSecurityGroups]" - ) -> None: - """Sets the database_security_groups of this GsaDatabaseSecurityGroupsInfo. - - Parameters - ---------- - database_security_groups: list[GsaDatabaseSecurityGroups] - The database_security_groups of this GsaDatabaseSecurityGroupsInfo. - """ - # Field is not nullable - if database_security_groups is None: - raise ValueError("Invalid value for 'database_security_groups', must not be 'None'") - # Field is required - if database_security_groups is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_security_groups', must not be 'Unset'") - self._database_security_groups = database_security_groups - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseSecurityGroupsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_status.py index 01309af0c..6a420f601 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_status.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_status.py @@ -52,4 +52,3 @@ class GsaDatabaseStatus(Enum): DISABLED = "Disabled" SCHEMAUPGRADEREQUIRED = "SchemaUpgradeRequired" SCHEMADOWNGRADEREQUIRED = "SchemaDowngradeRequired" - MISSING = "Missing" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_user_capabilities.py deleted file mode 100644 index 804dd2dfa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_database_user_capabilities.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDatabaseUserCapabilities(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read": "bool", - "can_write": "bool", - } - - attribute_map: dict[str, str] = { - "can_read": "canRead", - "can_write": "canWrite", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read: "bool", - can_write: "bool", - ) -> None: - """GsaDatabaseUserCapabilities - a model defined in Swagger - - Parameters - ---------- - can_read: bool - can_write: bool - """ - self._can_read: bool - self._can_write: bool - - self.can_read = can_read - self.can_write = can_write - - @property - def can_read(self) -> "bool": - """Gets the can_read of this GsaDatabaseUserCapabilities. - Specifies whether the current user can read from the database. - - Returns - ------- - bool - The can_read of this GsaDatabaseUserCapabilities. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool") -> None: - """Sets the can_read of this GsaDatabaseUserCapabilities. - Specifies whether the current user can read from the database. - - Parameters - ---------- - can_read: bool - The can_read of this GsaDatabaseUserCapabilities. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - # Field is required - if can_read is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read', must not be 'Unset'") - self._can_read = can_read - - @property - def can_write(self) -> "bool": - """Gets the can_write of this GsaDatabaseUserCapabilities. - Specifies whether the current user can write to the database. - - Returns - ------- - bool - The can_write of this GsaDatabaseUserCapabilities. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaDatabaseUserCapabilities. - Specifies whether the current user can write to the database. - - Parameters - ---------- - can_write: bool - The can_write of this GsaDatabaseUserCapabilities. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - # Field is required - if can_write is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write', must not be 'Unset'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDatabaseUserCapabilities): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_date_time_attribute.py index 581b634df..c9102e68b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_date_time_attribute.py @@ -69,7 +69,6 @@ class GsaDateTimeAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaDateTimeAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DATETIME, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion.py index ea81376e0..c330c4c59 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion.py @@ -103,7 +103,7 @@ class GsaDatumCriterion(ModelBase): "range".lower(): "#/components/schemas/GsaRangeDatumCriterion", "shortText".lower(): "#/components/schemas/GsaShortTextDatumCriterion", "shortTextPrefix".lower(): "#/components/schemas/GsaShortTextPrefixDatumCriterion", - "smartLinkingValue".lower(): "#/components/schemas/GsaLinkingValueExistsDatumCriterion", + "dynamicLinkingValue".lower(): "#/components/schemas/GsaLinkingValueExistsDatumCriterion", } discriminator: Optional[str] = "type" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion_type.py index bb5b3cde6..ac2f8a4ca 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_datum_criterion_type.py @@ -70,4 +70,4 @@ class GsaDatumCriterionType(Enum): RANGE = "range" SHORTTEXT = "shortText" SHORTTEXTPREFIX = "shortTextPrefix" - SMARTLINKINGVALUE = "smartLinkingValue" + DYNAMICLINKINGVALUE = "dynamicLinkingValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_fallback_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_fallback_security_groups.py deleted file mode 100644 index 6a3a3faf4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_fallback_security_groups.py +++ /dev/null @@ -1,317 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultFallbackSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "system_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "system_group": "systemGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str", - grant_group: "str", - power_user_group: "str", - read_group: "str", - system_group: "str", - write_group: "str", - ) -> None: - """GsaDefaultFallbackSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str - grant_group: str - power_user_group: str - read_group: str - system_group: str - write_group: str - """ - self._system_group: str - self._admin_group: str - self._grant_group: str - self._power_user_group: str - self._write_group: str - self._read_group: str - - self.system_group = system_group - self.admin_group = admin_group - self.grant_group = grant_group - self.power_user_group = power_user_group - self.write_group = write_group - self.read_group = read_group - - @property - def system_group(self) -> "str": - """Gets the system_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The system_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._system_group - - @system_group.setter - def system_group(self, system_group: "str") -> None: - """Sets the system_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - system_group: str - The system_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if system_group is None: - raise ValueError("Invalid value for 'system_group', must not be 'None'") - # Field is required - if system_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'system_group', must not be 'Unset'") - self._system_group = system_group - - @property - def admin_group(self) -> "str": - """Gets the admin_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The admin_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str") -> None: - """Sets the admin_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - admin_group: str - The admin_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - # Field is required - if admin_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'admin_group', must not be 'Unset'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str": - """Gets the grant_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The grant_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str") -> None: - """Sets the grant_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - grant_group: str - The grant_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - # Field is required - if grant_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'grant_group', must not be 'Unset'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str": - """Gets the power_user_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The power_user_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str") -> None: - """Sets the power_user_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - power_user_group: str - The power_user_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - # Field is required - if power_user_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'power_user_group', must not be 'Unset'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str": - """Gets the write_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The write_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str") -> None: - """Sets the write_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - write_group: str - The write_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - # Field is required - if write_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'write_group', must not be 'Unset'") - self._write_group = write_group - - @property - def read_group(self) -> "str": - """Gets the read_group of this GsaDefaultFallbackSecurityGroups. - - Returns - ------- - str - The read_group of this GsaDefaultFallbackSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str") -> None: - """Sets the read_group of this GsaDefaultFallbackSecurityGroups. - - Parameters - ---------- - read_group: str - The read_group of this GsaDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - # Field is required - if read_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'read_group', must not be 'Unset'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultFallbackSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_layout_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_layout_guid_error_detail.py deleted file mode 100644 index b0e2668d5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_layout_guid_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultLayoutGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.DEFAULTLAYOUTGUID, - ) -> None: - """GsaDefaultLayoutGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultLayoutGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_guid_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_guid_parameter_error_detail.py deleted file mode 100644 index 53397eb77..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_guid_parameter_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueGuidParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "default_parameter_value_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "default_parameter_value_guid": "defaultParameterValueGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEGUID, - default_parameter_value_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaDefaultParameterValueGuidParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - default_parameter_value_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._default_parameter_value_guid: str | Unset_Type = Unset - - if default_parameter_value_guid is not Unset: - self.default_parameter_value_guid = default_parameter_value_guid - - @property - def default_parameter_value_guid(self) -> "str | Unset_Type": - """Gets the default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - - Returns - ------- - str | Unset_Type - The default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - """ - return self._default_parameter_value_guid - - @default_parameter_value_guid.setter - def default_parameter_value_guid( - self, default_parameter_value_guid: "str | Unset_Type" - ) -> None: - """Sets the default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - - Parameters - ---------- - default_parameter_value_guid: str | Unset_Type - The default_parameter_value_guid of this GsaDefaultParameterValueGuidParameterErrorDetail. - """ - # Field is not nullable - if default_parameter_value_guid is None: - raise ValueError("Invalid value for 'default_parameter_value_guid', must not be 'None'") - self._default_parameter_value_guid = default_parameter_value_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueGuidParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py deleted file mode 100644 index 3c49e7afb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_and_guid_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexAndGuidParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEXANDGUID, - ) -> None: - """GsaDefaultParameterValueIndexAndGuidParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexAndGuidParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_parameter_error_detail.py deleted file mode 100644 index 17edffd90..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_parameter_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "default_parameter_value_index": "int", - "number_of_parameter_values": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "default_parameter_value_index": "defaultParameterValueIndex", - "number_of_parameter_values": "numberOfParameterValues", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEX, - default_parameter_value_index: "int | Unset_Type" = Unset, - number_of_parameter_values: "int | Unset_Type" = Unset, - ) -> None: - """GsaDefaultParameterValueIndexParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - default_parameter_value_index: int, optional - number_of_parameter_values: int, optional - """ - super().__init__(message=message, reason=reason) - self._default_parameter_value_index: int | Unset_Type = Unset - self._number_of_parameter_values: int | Unset_Type = Unset - - if default_parameter_value_index is not Unset: - self.default_parameter_value_index = default_parameter_value_index - if number_of_parameter_values is not Unset: - self.number_of_parameter_values = number_of_parameter_values - - @property - def default_parameter_value_index(self) -> "int | Unset_Type": - """Gets the default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Returns - ------- - int | Unset_Type - The default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - return self._default_parameter_value_index - - @default_parameter_value_index.setter - def default_parameter_value_index( - self, default_parameter_value_index: "int | Unset_Type" - ) -> None: - """Sets the default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Parameters - ---------- - default_parameter_value_index: int | Unset_Type - The default_parameter_value_index of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - # Field is not nullable - if default_parameter_value_index is None: - raise ValueError( - "Invalid value for 'default_parameter_value_index', must not be 'None'" - ) - self._default_parameter_value_index = default_parameter_value_index - - @property - def number_of_parameter_values(self) -> "int | Unset_Type": - """Gets the number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Returns - ------- - int | Unset_Type - The number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - return self._number_of_parameter_values - - @number_of_parameter_values.setter - def number_of_parameter_values(self, number_of_parameter_values: "int | Unset_Type") -> None: - """Sets the number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - - Parameters - ---------- - number_of_parameter_values: int | Unset_Type - The number_of_parameter_values of this GsaDefaultParameterValueIndexParameterErrorDetail. - """ - # Field is not nullable - if number_of_parameter_values is None: - raise ValueError("Invalid value for 'number_of_parameter_values', must not be 'None'") - self._number_of_parameter_values = number_of_parameter_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py deleted file mode 100644 index 49ee8f132..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_parameter_value_index_without_values_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.DEFAULTPARAMETERVALUEINDEXWITHOUTVALUES, - ) -> None: - """GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_subset_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_subset_guid_error_detail.py deleted file mode 100644 index 9b99513bc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_default_subset_guid_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDefaultSubsetGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.DEFAULTSUBSETGUID, - ) -> None: - """GsaDefaultSubsetGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDefaultSubsetGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_description_length_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_description_length_file_error_detail.py deleted file mode 100644 index 1cebefb06..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_description_length_file_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDescriptionLengthFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "max_length_of_file_description": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "max_length_of_file_description": "maxLengthOfFileDescription", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.DESCRIPTIONLENGTH, - max_length_of_file_description: "int | Unset_Type" = Unset, - ) -> None: - """GsaDescriptionLengthFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - max_length_of_file_description: int, optional - """ - super().__init__(message=message, reason=reason) - self._max_length_of_file_description: int | Unset_Type = Unset - - if max_length_of_file_description is not Unset: - self.max_length_of_file_description = max_length_of_file_description - - @property - def max_length_of_file_description(self) -> "int | Unset_Type": - """Gets the max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - - Returns - ------- - int | Unset_Type - The max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - """ - return self._max_length_of_file_description - - @max_length_of_file_description.setter - def max_length_of_file_description( - self, max_length_of_file_description: "int | Unset_Type" - ) -> None: - """Sets the max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - - Parameters - ---------- - max_length_of_file_description: int | Unset_Type - The max_length_of_file_description of this GsaDescriptionLengthFileErrorDetail. - """ - # Field is not nullable - if max_length_of_file_description is None: - raise ValueError( - "Invalid value for 'max_length_of_file_description', must not be 'None'" - ) - self._max_length_of_file_description = max_length_of_file_description - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDescriptionLengthFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_attribute.py index 0bf576fc1..d4be85481 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_attribute.py @@ -71,7 +71,6 @@ class GsaDiscreteAttribute(GsaAttribute): "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -88,7 +87,6 @@ class GsaDiscreteAttribute(GsaAttribute): "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -113,7 +111,6 @@ def __init__( info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", is_multi_valued: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DISCRETE, @@ -132,7 +129,6 @@ def __init__( info: GsaAttributeInfo is_hidden_from_search_criteria: bool is_multi_valued: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -146,7 +142,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_functional_attribute.py index e8c507696..4a736d8bc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_functional_attribute.py @@ -71,7 +71,6 @@ class GsaDiscreteFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -88,7 +87,6 @@ class GsaDiscreteFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -114,7 +112,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.DISCRETEFUNCTIONAL, @@ -133,7 +130,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -147,7 +143,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_parameter.py index 86e2d4f48..0460285bc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_parameter.py @@ -70,6 +70,7 @@ class GsaDiscreteParameter(GsaParameter): "name": "str", "type": "GsaParameterType", "values": "list[GsaDiscreteParameterValue]", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -79,6 +80,7 @@ class GsaDiscreteParameter(GsaParameter): "name": "name", "type": "type", "values": "values", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -96,6 +98,7 @@ def __init__( name: "str", type: "GsaParameterType" = GsaParameterType.DISCRETE, values: "list[GsaDiscreteParameterValue]", + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaDiscreteParameter - a model defined in Swagger @@ -107,6 +110,7 @@ def __init__( name: str type: GsaParameterType values: list[GsaDiscreteParameterValue] + help_path: str | None, optional """ super().__init__( default_parameter_value_guid=default_parameter_value_guid, @@ -114,6 +118,7 @@ def __init__( guid=guid, name=name, type=type, + help_path=help_path, ) self._values: list[GsaDiscreteParameterValue] diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_quality_system.py deleted file mode 100644 index d29fe5446..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_quality_system.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_quality_system import ( # noqa: F401 - GsaQualitySystem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_quality_system_type import ( - GsaQualitySystemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteQualitySystem(GsaQualitySystem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "quality_discrete_values": "list[GsaQualityDiscreteValue]", - "threshold_value": "GsaQualityDiscreteValue", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "quality_discrete_values": "qualityDiscreteValues", - "threshold_value": "thresholdValue", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "thresholdValue": "GsaQualityDiscreteValue", - "qualityDiscreteValues": "GsaQualityDiscreteValue", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - quality_discrete_values: "list[GsaQualityDiscreteValue]", - threshold_value: "GsaQualityDiscreteValue", - type: "GsaQualitySystemType" = GsaQualitySystemType.DISCRETE, - ) -> None: - """GsaDiscreteQualitySystem - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - quality_discrete_values: list[GsaQualityDiscreteValue] - threshold_value: GsaQualityDiscreteValue - type: GsaQualitySystemType - """ - super().__init__(guid=guid, name=name, type=type) - self._threshold_value: GsaQualityDiscreteValue - self._quality_discrete_values: list[GsaQualityDiscreteValue] - - self.threshold_value = threshold_value - self.quality_discrete_values = quality_discrete_values - - @property - def threshold_value(self) -> "GsaQualityDiscreteValue": - """Gets the threshold_value of this GsaDiscreteQualitySystem. - - Returns - ------- - GsaQualityDiscreteValue - The threshold_value of this GsaDiscreteQualitySystem. - """ - return self._threshold_value - - @threshold_value.setter - def threshold_value(self, threshold_value: "GsaQualityDiscreteValue") -> None: - """Sets the threshold_value of this GsaDiscreteQualitySystem. - - Parameters - ---------- - threshold_value: GsaQualityDiscreteValue - The threshold_value of this GsaDiscreteQualitySystem. - """ - # Field is not nullable - if threshold_value is None: - raise ValueError("Invalid value for 'threshold_value', must not be 'None'") - # Field is required - if threshold_value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'threshold_value', must not be 'Unset'") - self._threshold_value = threshold_value - - @property - def quality_discrete_values(self) -> "list[GsaQualityDiscreteValue]": - """Gets the quality_discrete_values of this GsaDiscreteQualitySystem. - - Returns - ------- - list[GsaQualityDiscreteValue] - The quality_discrete_values of this GsaDiscreteQualitySystem. - """ - return self._quality_discrete_values - - @quality_discrete_values.setter - def quality_discrete_values( - self, quality_discrete_values: "list[GsaQualityDiscreteValue]" - ) -> None: - """Sets the quality_discrete_values of this GsaDiscreteQualitySystem. - - Parameters - ---------- - quality_discrete_values: list[GsaQualityDiscreteValue] - The quality_discrete_values of this GsaDiscreteQualitySystem. - """ - # Field is not nullable - if quality_discrete_values is None: - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'None'") - # Field is required - if quality_discrete_values is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'quality_discrete_values', must not be 'Unset'") - self._quality_discrete_values = quality_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type.py index ed02a20c9..5d0faec50 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type.py @@ -64,7 +64,6 @@ class GsaDiscreteType(ModelBase): "discrete_values": "list[GsaDiscreteValuesDiscreteValue]", "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } @@ -72,7 +71,6 @@ class GsaDiscreteType(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "list[GsaDiscreteValuesDiscreteValue]", guid: "str", is_ordered: "bool", - is_protected: "bool", name: "str", ) -> None: """GsaDiscreteType - a model defined in Swagger @@ -98,18 +95,15 @@ def __init__( discrete_values: list[GsaDiscreteValuesDiscreteValue] guid: str is_ordered: bool - is_protected: bool name: str """ self._discrete_values: list[GsaDiscreteValuesDiscreteValue] self._is_ordered: bool - self._is_protected: bool self._name: str self._guid: str self.discrete_values = discrete_values self.is_ordered = is_ordered - self.is_protected = is_protected self.name = name self.guid = guid @@ -169,36 +163,6 @@ def is_ordered(self, is_ordered: "bool") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'Unset'") self._is_ordered = is_ordered - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaDiscreteType. - If true, the discrete type is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaDiscreteType. - If true, the discrete type is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaDiscreteType. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_deletion_exception.py index 682e53515..f469d901e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_deletion_exception.py @@ -61,21 +61,19 @@ class GsaDiscreteTypeDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaDiscreteTypeDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaDiscreteTypeDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaDiscreteTypeDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaDiscreteTypeDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaDiscreteTypeDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaDiscreteTypeDeletionException. - - Returns - ------- - str - The guid of this GsaDiscreteTypeDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaDiscreteTypeDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaDiscreteTypeDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaDiscreteTypeDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage.py index b3ead318f..b4c81fcd3 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage.py @@ -80,68 +80,76 @@ class GsaDiscreteTypeUsage(ModelBase): def __init__( self, *, - attributes: "list[GsaSlimAttribute] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" = Unset, + attributes: "list[GsaSlimAttribute]", + tabular_columns: "list[GsaTabularAttributeWithColumns]", ) -> None: """GsaDiscreteTypeUsage - a model defined in Swagger Parameters ---------- - attributes: list[GsaSlimAttribute] | None, optional - tabular_columns: list[GsaTabularAttributeWithColumns] | None, optional + attributes: list[GsaSlimAttribute] + tabular_columns: list[GsaTabularAttributeWithColumns] """ - self._attributes: list[GsaSlimAttribute] | None | Unset_Type = Unset - self._tabular_columns: list[GsaTabularAttributeWithColumns] | None | Unset_Type = Unset + self._attributes: list[GsaSlimAttribute] + self._tabular_columns: list[GsaTabularAttributeWithColumns] - if attributes is not Unset: - self.attributes = attributes - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns + self.attributes = attributes + self.tabular_columns = tabular_columns @property - def attributes(self) -> "list[GsaSlimAttribute] | None | Unset_Type": + def attributes(self) -> "list[GsaSlimAttribute]": """Gets the attributes of this GsaDiscreteTypeUsage. Returns ------- - list[GsaSlimAttribute] | None | Unset_Type + list[GsaSlimAttribute] The attributes of this GsaDiscreteTypeUsage. """ return self._attributes @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttribute] | None | Unset_Type") -> None: + def attributes(self, attributes: "list[GsaSlimAttribute]") -> None: """Sets the attributes of this GsaDiscreteTypeUsage. Parameters ---------- - attributes: list[GsaSlimAttribute] | None | Unset_Type + attributes: list[GsaSlimAttribute] The attributes of this GsaDiscreteTypeUsage. """ + # Field is not nullable + if attributes is None: + raise ValueError("Invalid value for 'attributes', must not be 'None'") + # Field is required + if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'attributes', must not be 'Unset'") self._attributes = attributes @property - def tabular_columns(self) -> "list[GsaTabularAttributeWithColumns] | None | Unset_Type": + def tabular_columns(self) -> "list[GsaTabularAttributeWithColumns]": """Gets the tabular_columns of this GsaDiscreteTypeUsage. Returns ------- - list[GsaTabularAttributeWithColumns] | None | Unset_Type + list[GsaTabularAttributeWithColumns] The tabular_columns of this GsaDiscreteTypeUsage. """ return self._tabular_columns @tabular_columns.setter - def tabular_columns( - self, tabular_columns: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" - ) -> None: + def tabular_columns(self, tabular_columns: "list[GsaTabularAttributeWithColumns]") -> None: """Sets the tabular_columns of this GsaDiscreteTypeUsage. Parameters ---------- - tabular_columns: list[GsaTabularAttributeWithColumns] | None | Unset_Type + tabular_columns: list[GsaTabularAttributeWithColumns] The tabular_columns of this GsaDiscreteTypeUsage. """ + # Field is not nullable + if tabular_columns is None: + raise ValueError("Invalid value for 'tabular_columns', must not be 'None'") + # Field is required + if tabular_columns is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'tabular_columns', must not be 'Unset'") self._tabular_columns = tabular_columns @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage_type.py deleted file mode 100644 index 866ef7d7d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_type_usage_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDiscreteTypeUsageType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTES = "attributes" - TABULARCOLUMNS = "tabularColumns" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_aggregate_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_aggregate_exception.py index dc6bc49bb..bb8b622c7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_aggregate_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_aggregate_exception.py @@ -62,7 +62,7 @@ class GsaDiscreteValueAggregateException(ModelBase): """ swagger_types: dict[str, str] = { "reason": "GsaDiscreteValueAggregateErrorReason", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaErrorDetail]", "message": "str", } @@ -76,7 +76,7 @@ class GsaDiscreteValueAggregateException(ModelBase): subtype_mapping: dict[str, str] = { "reason": "GsaDiscreteValueAggregateErrorReason", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaErrorDetail", } @@ -86,7 +86,7 @@ def __init__( self, *, reason: "GsaDiscreteValueAggregateErrorReason", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -95,13 +95,13 @@ def __init__( Parameters ---------- reason: GsaDiscreteValueAggregateErrorReason - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset self._reason: GsaDiscreteValueAggregateErrorReason - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -163,23 +163,23 @@ def reason(self, reason: "GsaDiscreteValueAggregateErrorReason") -> None: self._reason = reason @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaDiscreteValueAggregateException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaDiscreteValueAggregateException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaDiscreteValueAggregateException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaDiscreteValueAggregateException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_not_in_discrete_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_not_in_discrete_type_error_detail.py deleted file mode 100644 index 1783efd92..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_value_not_in_discrete_type_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDiscreteValueNotInDiscreteTypeErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_type_guid": "str", - "discrete_value_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "discrete_type_guid": "discreteTypeGuid", - "discrete_value_guid": "discreteValueGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_type_guid: "str", - discrete_value_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DISCRETEVALUENOTINDISCRETETYPE, - ) -> None: - """GsaDiscreteValueNotInDiscreteTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - discrete_type_guid: str - discrete_value_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._discrete_value_guid: str - self._discrete_type_guid: str - - self.discrete_value_guid = discrete_value_guid - self.discrete_type_guid = discrete_type_guid - - @property - def discrete_value_guid(self) -> "str": - """Gets the discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Returns - ------- - str - The discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str") -> None: - """Sets the discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Parameters - ---------- - discrete_value_guid: str - The discrete_value_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - # Field is required - if discrete_value_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'Unset'") - self._discrete_value_guid = discrete_value_guid - - @property - def discrete_type_guid(self) -> "str": - """Gets the discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Returns - ------- - str - The discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - return self._discrete_type_guid - - @discrete_type_guid.setter - def discrete_type_guid(self, discrete_type_guid: "str") -> None: - """Sets the discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - - Parameters - ---------- - discrete_type_guid: str - The discrete_type_guid of this GsaDiscreteValueNotInDiscreteTypeErrorDetail. - """ - # Field is not nullable - if discrete_type_guid is None: - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'None'") - # Field is required - if discrete_type_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_type_guid', must not be 'Unset'") - self._discrete_type_guid = discrete_type_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteValueNotInDiscreteTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_values_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_values_discrete_value.py index 5fa30de68..c64562822 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_values_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_values_discrete_value.py @@ -62,13 +62,11 @@ class GsaDiscreteValuesDiscreteValue(ModelBase): """ swagger_types: dict[str, str] = { "guid": "str", - "is_protected": "bool", "name": "str", } attribute_map: dict[str, str] = { "guid": "guid", - "is_protected": "isProtected", "name": "name", } @@ -80,7 +78,6 @@ def __init__( self, *, guid: "str", - is_protected: "bool", name: "str", ) -> None: """GsaDiscreteValuesDiscreteValue - a model defined in Swagger @@ -88,47 +85,14 @@ def __init__( Parameters ---------- guid: str - is_protected: bool name: str """ - self._is_protected: bool self._name: str self._guid: str - self.is_protected = is_protected self.name = name self.guid = guid - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaDiscreteValuesDiscreteValue. - If true, the discrete value is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaDiscreteValuesDiscreteValue. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaDiscreteValuesDiscreteValue. - If true, the discrete value is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaDiscreteValuesDiscreteValue. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaDiscreteValuesDiscreteValue. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_empty_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_empty_error_detail.py deleted file mode 100644 index 55f210339..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_empty_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameEmptyErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "language": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "language": "language", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMEEMPTY, - language: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameEmptyErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - language: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._language: str | None | Unset_Type = Unset - - if language is not Unset: - self.language = language - - @property - def language(self) -> "str | None | Unset_Type": - """Gets the language of this GsaDisplayNameEmptyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The language of this GsaDisplayNameEmptyErrorDetail. - """ - return self._language - - @language.setter - def language(self, language: "str | None | Unset_Type") -> None: - """Sets the language of this GsaDisplayNameEmptyErrorDetail. - - Parameters - ---------- - language: str | None | Unset_Type - The language of this GsaDisplayNameEmptyErrorDetail. - """ - self._language = language - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameEmptyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_provided_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_provided_error_detail.py deleted file mode 100644 index 97096a45c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_provided_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameLanguageNotProvidedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "display_name": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "display_name": "displayName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMELANGUAGENOTPROVIDED, - display_name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameLanguageNotProvidedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - display_name: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._display_name: str | None | Unset_Type = Unset - - if display_name is not Unset: - self.display_name = display_name - - @property - def display_name(self) -> "str | None | Unset_Type": - """Gets the display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name: "str | None | Unset_Type") -> None: - """Sets the display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - - Parameters - ---------- - display_name: str | None | Unset_Type - The display_name of this GsaDisplayNameLanguageNotProvidedErrorDetail. - """ - self._display_name = display_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameLanguageNotProvidedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_supported_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_supported_error_detail.py deleted file mode 100644 index 6fdf320b2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_name_language_not_supported_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNameLanguageNotSupportedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "language": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "language": "language", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.DISPLAYNAMELANGUAGENOTSUPPORTED, - language: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNameLanguageNotSupportedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - language: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._language: str | None | Unset_Type = Unset - - if language is not Unset: - self.language = language - - @property - def language(self) -> "str | None | Unset_Type": - """Gets the language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - """ - return self._language - - @language.setter - def language(self, language: "str | None | Unset_Type") -> None: - """Sets the language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - - Parameters - ---------- - language: str | None | Unset_Type - The language of this GsaDisplayNameLanguageNotSupportedErrorDetail. - """ - self._language = language - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNameLanguageNotSupportedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_detail.py deleted file mode 100644 index 472a6e958..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_detail.py +++ /dev/null @@ -1,297 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesImportErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "column_header": "str", - "field_value": "str", - "item_type": "str", - "reason": "GsaDisplayNamesImportErrorReason", - "row_index": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "column_header": "columnHeader", - "field_value": "fieldValue", - "item_type": "itemType", - "reason": "reason", - "row_index": "rowIndex", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaDisplayNamesImportErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - column_header: "str | None | Unset_Type" = Unset, - field_value: "str | None | Unset_Type" = Unset, - item_type: "str | None | Unset_Type" = Unset, - reason: "GsaDisplayNamesImportErrorReason | Unset_Type" = Unset, - row_index: "int | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesImportErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - column_header: str | None, optional - field_value: str | None, optional - item_type: str | None, optional - reason: GsaDisplayNamesImportErrorReason, optional - row_index: int | None, optional - """ - self._message: str - self._reason: GsaDisplayNamesImportErrorReason | Unset_Type = Unset - self._row_index: int | None | Unset_Type = Unset - self._field_value: str | None | Unset_Type = Unset - self._column_header: str | None | Unset_Type = Unset - self._item_type: str | None | Unset_Type = Unset - - self.message = message - if reason is not Unset: - self.reason = reason - if row_index is not Unset: - self.row_index = row_index - if field_value is not Unset: - self.field_value = field_value - if column_header is not Unset: - self.column_header = column_header - if item_type is not Unset: - self.item_type = item_type - - @property - def message(self) -> "str": - """Gets the message of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str - The message of this GsaDisplayNamesImportErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaDisplayNamesImportErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaDisplayNamesImportErrorReason | Unset_Type": - """Gets the reason of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - GsaDisplayNamesImportErrorReason | Unset_Type - The reason of this GsaDisplayNamesImportErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaDisplayNamesImportErrorReason | Unset_Type") -> None: - """Sets the reason of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - reason: GsaDisplayNamesImportErrorReason | Unset_Type - The reason of this GsaDisplayNamesImportErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - self._reason = reason - - @property - def row_index(self) -> "int | None | Unset_Type": - """Gets the row_index of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - int | None | Unset_Type - The row_index of this GsaDisplayNamesImportErrorDetail. - """ - return self._row_index - - @row_index.setter - def row_index(self, row_index: "int | None | Unset_Type") -> None: - """Sets the row_index of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - row_index: int | None | Unset_Type - The row_index of this GsaDisplayNamesImportErrorDetail. - """ - self._row_index = row_index - - @property - def field_value(self) -> "str | None | Unset_Type": - """Gets the field_value of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The field_value of this GsaDisplayNamesImportErrorDetail. - """ - return self._field_value - - @field_value.setter - def field_value(self, field_value: "str | None | Unset_Type") -> None: - """Sets the field_value of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - field_value: str | None | Unset_Type - The field_value of this GsaDisplayNamesImportErrorDetail. - """ - self._field_value = field_value - - @property - def column_header(self) -> "str | None | Unset_Type": - """Gets the column_header of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The column_header of this GsaDisplayNamesImportErrorDetail. - """ - return self._column_header - - @column_header.setter - def column_header(self, column_header: "str | None | Unset_Type") -> None: - """Sets the column_header of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - column_header: str | None | Unset_Type - The column_header of this GsaDisplayNamesImportErrorDetail. - """ - self._column_header = column_header - - @property - def item_type(self) -> "str | None | Unset_Type": - """Gets the item_type of this GsaDisplayNamesImportErrorDetail. - - Returns - ------- - str | None | Unset_Type - The item_type of this GsaDisplayNamesImportErrorDetail. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "str | None | Unset_Type") -> None: - """Sets the item_type of this GsaDisplayNamesImportErrorDetail. - - Parameters - ---------- - item_type: str | None | Unset_Type - The item_type of this GsaDisplayNamesImportErrorDetail. - """ - self._item_type = item_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesImportErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_reason.py deleted file mode 100644 index 974ae3b7a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_error_reason.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaDisplayNamesImportErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "unknown" - MALFORMEDLINE = "malformedLine" - INCORRECTNUMBEROFCOLUMNS = "incorrectNumberOfColumns" - INVALIDSCHEMATYPE = "invalidSchemaType" - INVALIDLANGUAGE = "invalidLanguage" - SCHEMAITEMNOTFOUND = "schemaItemNotFound" - EMPTYCOLUMN = "emptyColumn" - EXTRAINFOMISSING = "extraInfoMissing" - TRANSLATIONTOOLONG = "translationTooLong" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_exception.py deleted file mode 100644 index 020ae95c7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_import_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesImportException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaDisplayNamesImportErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDisplayNamesImportErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesImportException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaDisplayNamesImportErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaDisplayNamesImportException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaDisplayNamesImportException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaDisplayNamesImportException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaDisplayNamesImportException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaDisplayNamesImportException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaDisplayNamesImportException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaDisplayNamesImportException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaDisplayNamesImportException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaDisplayNamesImportException. - - Returns - ------- - list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type - The errors of this GsaDisplayNamesImportException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaDisplayNamesImportException. - - Parameters - ---------- - errors: list[GsaDisplayNamesImportErrorDetail] | None | Unset_Type - The errors of this GsaDisplayNamesImportException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesImportException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_info.py deleted file mode 100644 index ae390d627..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_display_names_info.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDisplayNamesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "GsaGrid", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - } - - subtype_mapping: dict[str, str] = { - "displayNames": "GsaGrid", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "GsaGrid | Unset_Type" = Unset, - ) -> None: - """GsaDisplayNamesInfo - a model defined in Swagger - - Parameters - ---------- - display_names: GsaGrid, optional - """ - self._display_names: GsaGrid | Unset_Type = Unset - - if display_names is not Unset: - self.display_names = display_names - - @property - def display_names(self) -> "GsaGrid | Unset_Type": - """Gets the display_names of this GsaDisplayNamesInfo. - - Returns - ------- - GsaGrid | Unset_Type - The display_names of this GsaDisplayNamesInfo. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "GsaGrid | Unset_Type") -> None: - """Sets the display_names of this GsaDisplayNamesInfo. - - Parameters - ---------- - display_names: GsaGrid | Unset_Type - The display_names of this GsaDisplayNamesInfo. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - self._display_names = display_names - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDisplayNamesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_divide_by_zero_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_divide_by_zero_unit_equation_error_detail.py deleted file mode 100644 index fd6fd5223..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_divide_by_zero_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDivideByZeroUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.DIVIDEBYZERO, - ) -> None: - """GsaDivideByZeroUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDivideByZeroUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_categories_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_categories_replace_permission_category_error_detail.py deleted file mode 100644 index 82127ecfa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_categories_replace_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "duplicate_names": "list[str]", - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "duplicate_names": "duplicateNames", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - duplicate_names: "list[str]", - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.DUPLICATECATEGORIES, - ) -> None: - """GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - duplicate_names: list[str] - message: str - reason: GsaReplacePermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_names: list[str] - self._duplicate_guids: list[str] - - self.duplicate_names = duplicate_names - self.duplicate_guids = duplicate_guids - - @property - def duplicate_names(self) -> "list[str]": - """Gets the duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._duplicate_names - - @duplicate_names.setter - def duplicate_names(self, duplicate_names: "list[str]") -> None: - """Sets the duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_names: list[str] - The duplicate_names of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_names is None: - raise ValueError("Invalid value for 'duplicate_names', must not be 'None'") - # Field is required - if duplicate_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_names', must not be 'Unset'") - self._duplicate_names = duplicate_names - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_category_guids_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_category_guids_access_control_error_detail.py deleted file mode 100644 index 8825eb1d7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_category_guids_access_control_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCategoryGuidsAccessControlErrorDetail( - GsaPermissionCategoriesAccessControlErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.DUPLICATECATEGORYGUIDS, - ) -> None: - """GsaDuplicateCategoryGuidsAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_guids: list[str] - - self.duplicate_guids = duplicate_guids - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicateCategoryGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCategoryGuidsAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_code_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_code_currency_error_detail.py deleted file mode 100644 index ce21febbf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_code_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateCodeCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "currency_code": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "currency_code": "currencyCode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.DUPLICATECODE, - currency_code: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDuplicateCodeCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - currency_code: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._currency_code: str | None | Unset_Type = Unset - - if currency_code is not Unset: - self.currency_code = currency_code - - @property - def currency_code(self) -> "str | None | Unset_Type": - """Gets the currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code: "str | None | Unset_Type") -> None: - """Sets the currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - - Parameters - ---------- - currency_code: str | None | Unset_Type - The currency_code of this GsaDuplicateCodeCurrencyErrorDetail. - """ - self._currency_code = currency_code - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateCodeCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_discrete_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_discrete_value_error_detail.py deleted file mode 100644 index 2771aae49..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_discrete_value_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateDiscreteValueErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "discrete_value_guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "discrete_value_guid": "discreteValueGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - discrete_value_guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DUPLICATEDISCRETEVALUE, - ) -> None: - """GsaDuplicateDiscreteValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - discrete_value_guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._discrete_value_guid: str - - self.discrete_value_guid = discrete_value_guid - - @property - def discrete_value_guid(self) -> "str": - """Gets the discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - - Returns - ------- - str - The discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - """ - return self._discrete_value_guid - - @discrete_value_guid.setter - def discrete_value_guid(self, discrete_value_guid: "str") -> None: - """Sets the discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - - Parameters - ---------- - discrete_value_guid: str - The discrete_value_guid of this GsaDuplicateDiscreteValueErrorDetail. - """ - # Field is not nullable - if discrete_value_guid is None: - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'None'") - # Field is required - if discrete_value_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'discrete_value_guid', must not be 'Unset'") - self._discrete_value_guid = discrete_value_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateDiscreteValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_attribute_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_attribute_guids_error_detail.py deleted file mode 100644 index e1378c07c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_attribute_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedAttributeGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDATTRIBUTEGUIDS, - ) -> None: - """GsaDuplicateMappedAttributeGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedAttributeGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py deleted file mode 100644 index ff0beebe4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_cross_database_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDCROSSDATABASERECORDLINKGROUPGUIDS, - ) -> None: - """GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_parameter_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_parameter_guids_error_detail.py deleted file mode 100644 index 1dd7b6020..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_parameter_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedParameterGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDPARAMETERGUIDS, - ) -> None: - """GsaDuplicateMappedParameterGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedParameterGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py deleted file mode 100644 index 557e11a0c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_mapped_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.DUPLICATEMAPPEDRECORDLINKGROUPGUIDS, - ) -> None: - """GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_name_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_name_currency_error_detail.py deleted file mode 100644 index 2f1408977..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_name_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateNameCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.DUPLICATENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaDuplicateNameCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDuplicateNameCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaDuplicateNameCurrencyErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDuplicateNameCurrencyErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaDuplicateNameCurrencyErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateNameCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permission_guids_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permission_guids_access_control_error_detail.py deleted file mode 100644 index 6e4400a2d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permission_guids_access_control_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicatePermissionGuidsAccessControlErrorDetail( - GsaPermissionCategoriesAccessControlErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "duplicate_guids": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "duplicate_guids": "duplicateGuids", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - duplicate_guids: "list[str]", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.DUPLICATEPERMISSIONGUIDS, - ) -> None: - """GsaDuplicatePermissionGuidsAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - duplicate_guids: list[str] - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._category_guid: str - self._duplicate_guids: list[str] - - self.category_guid = category_guid - self.duplicate_guids = duplicate_guids - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicatePermissionGuidsAccessControlErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicatePermissionGuidsAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permissions_permission_category_error_detail.py deleted file mode 100644 index ebc649afd..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicatePermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "duplicate_guids": "list[str]", - "duplicate_names": "list[str]", - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "duplicate_guids": "duplicateGuids", - "duplicate_names": "duplicateNames", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - duplicate_guids: "list[str]", - duplicate_names: "list[str]", - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.DUPLICATEPERMISSIONS, - ) -> None: - """GsaDuplicatePermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - duplicate_guids: list[str] - duplicate_names: list[str] - message: str - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._duplicate_names: list[str] - self._duplicate_guids: list[str] - - self.duplicate_names = duplicate_names - self.duplicate_guids = duplicate_guids - - @property - def duplicate_names(self) -> "list[str]": - """Gets the duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - return self._duplicate_names - - @duplicate_names.setter - def duplicate_names(self, duplicate_names: "list[str]") -> None: - """Sets the duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_names: list[str] - The duplicate_names of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_names is None: - raise ValueError("Invalid value for 'duplicate_names', must not be 'None'") - # Field is required - if duplicate_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_names', must not be 'Unset'") - self._duplicate_names = duplicate_names - - @property - def duplicate_guids(self) -> "list[str]": - """Gets the duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] - The duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - return self._duplicate_guids - - @duplicate_guids.setter - def duplicate_guids(self, duplicate_guids: "list[str]") -> None: - """Sets the duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - duplicate_guids: list[str] - The duplicate_guids of this GsaDuplicatePermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if duplicate_guids is None: - raise ValueError("Invalid value for 'duplicate_guids', must not be 'None'") - # Field is required - if duplicate_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'duplicate_guids', must not be 'Unset'") - self._duplicate_guids = duplicate_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicatePermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_symbol_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_symbol_unit_error_detail.py deleted file mode 100644 index 3764d19c0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_symbol_unit_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateSymbolUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.DUPLICATESYMBOL, - symbol: "str", - ) -> None: - """GsaDuplicateSymbolUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaDuplicateSymbolUnitErrorDetail. - - Returns - ------- - str - The symbol of this GsaDuplicateSymbolUnitErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaDuplicateSymbolUnitErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaDuplicateSymbolUnitErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateSymbolUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_table_error_detail.py deleted file mode 100644 index bed584798..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_duplicate_table_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaDuplicateTableErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.DUPLICATETABLE, - table_guid: "str", - ) -> None: - """GsaDuplicateTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._table_guid: str - - self.table_guid = table_guid - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaDuplicateTableErrorDetail. - - Returns - ------- - str - The table_guid of this GsaDuplicateTableErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaDuplicateTableErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaDuplicateTableErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaDuplicateTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py similarity index 88% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_usage_data_modification_error_detail.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py index c86d562f8..bd05dcad8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_constant_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_link_group_usage_data_modification_error_detail.py @@ -52,7 +52,7 @@ from . import * -class GsaConstantUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): +class GsaDynamicLinkGroupUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -95,10 +95,10 @@ def __init__( *, message: "str", reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.CONSTANT, + referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.DYNAMICLINKGROUP, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: - """GsaConstantUsageDataModificationErrorDetail - a model defined in Swagger + """GsaDynamicLinkGroupUsageDataModificationErrorDetail - a model defined in Swagger Parameters ---------- @@ -115,23 +115,23 @@ def __init__( @property def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaConstantUsageDataModificationErrorDetail. + """Gets the referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. Returns ------- list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaConstantUsageDataModificationErrorDetail. + The referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. """ return self._referenced_by @referenced_by.setter def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaConstantUsageDataModificationErrorDetail. + """Sets the referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. Parameters ---------- referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaConstantUsageDataModificationErrorDetail. + The referenced_by of this GsaDynamicLinkGroupUsageDataModificationErrorDetail. """ self._referenced_by = referenced_by @@ -157,7 +157,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaConstantUsageDataModificationErrorDetail): + if not isinstance(other, GsaDynamicLinkGroupUsageDataModificationErrorDetail): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_record_link_group.py similarity index 89% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_record_link_group.py index 997082c74..2445e97b5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaSmartRecordLinkGroup(GsaRecordLinkGroup): +class GsaDynamicRecordLinkGroup(GsaRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -113,11 +113,11 @@ def __init__( name: "str", referential_integrity_model: "GsaReferentialIntegrityModel", reverse_name: "str", - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, identity: "int | None | Unset_Type" = Unset, reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, ) -> None: - """GsaSmartRecordLinkGroup - a model defined in Swagger + """GsaDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- @@ -153,23 +153,23 @@ def __init__( @property def forbid_orphans(self) -> "bool": - """Gets the forbid_orphans of this GsaSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaDynamicRecordLinkGroup. Returns ------- bool - The forbid_orphans of this GsaSmartRecordLinkGroup. + The forbid_orphans of this GsaDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool") -> None: - """Sets the forbid_orphans of this GsaSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool - The forbid_orphans of this GsaSmartRecordLinkGroup. + The forbid_orphans of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -181,12 +181,12 @@ def forbid_orphans(self, forbid_orphans: "bool") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": - """Gets the referential_integrity_model of this GsaSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartRecordLinkGroup. + The referential_integrity_model of this GsaDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -194,12 +194,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel" ) -> None: - """Sets the referential_integrity_model of this GsaSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartRecordLinkGroup. + The referential_integrity_model of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -211,23 +211,23 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaAttributeLinkPair]": - """Gets the attribute_pairs of this GsaSmartRecordLinkGroup. + """Gets the attribute_pairs of this GsaDynamicRecordLinkGroup. Returns ------- list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartRecordLinkGroup. + The attribute_pairs of this GsaDynamicRecordLinkGroup. """ return self._attribute_pairs @attribute_pairs.setter def attribute_pairs(self, attribute_pairs: "list[GsaAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaSmartRecordLinkGroup. + """Sets the attribute_pairs of this GsaDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartRecordLinkGroup. + The attribute_pairs of this GsaDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -259,7 +259,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartRecordLinkGroup): + if not isinstance(other, GsaDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_symbol_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_symbol_unit_error_detail.py deleted file mode 100644 index 6f96bd7bc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_symbol_unit_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEmptySymbolUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.EMPTYSYMBOL, - ) -> None: - """GsaEmptySymbolUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEmptySymbolUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_table_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_table_type_error_detail.py deleted file mode 100644 index 779cdcac0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_empty_table_type_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_type_error_detail import ( # noqa: F401 - GsaTableTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_type_error_reason import ( - GsaTableTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEmptyTableTypeErrorDetail(GsaTableTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason" = GsaTableTypeErrorReason.EMPTYTABLETYPE, - ) -> None: - """GsaEmptyTableTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEmptyTableTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_already_exists_error_detail.py index 8350addae..96111ecb6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_already_exists_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_already_exists_error_detail.py @@ -68,16 +68,16 @@ class GsaEntityAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "guid": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "guid": "guid", } @@ -88,21 +88,21 @@ class GsaEntityAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.ENTITYALREADYEXISTS, + entity_type_name: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, ) -> None: """GsaEntityAlreadyExistsErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional guid: str, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._guid: str | Unset_Type = Unset if guid is not Unset: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_identifier_already_specified_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_identifier_already_specified_error_detail.py index af6b5f522..623609553 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_identifier_already_specified_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_identifier_already_specified_error_detail.py @@ -68,16 +68,16 @@ class GsaEntityIdentifierAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "guid": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "guid": "guid", } @@ -88,21 +88,21 @@ class GsaEntityIdentifierAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.ENTITYIDENTIFIERALREADYSPECIFIED, + entity_type_name: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, ) -> None: """GsaEntityIdentifierAlreadySpecifiedErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional guid: str, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._guid: str | Unset_Type = Unset if guid is not Unset: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_type.py deleted file mode 100644 index ab7544203..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_entity_type.py +++ /dev/null @@ -1,61 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaEntityType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTE = "attribute" - DATABASE = "database" - DISCRETEVALUE = "discreteValue" - DISCRETETYPE = "discreteType" - METAATTRIBUTE = "metaAttribute" - PARAMETER = "parameter" - PARAMETERVALUE = "parameterValue" - TABLE = "table" - FILE = "file" - FOLDER = "folder" - RECORDHISTORY = "recordHistory" - RECORDLINKGROUP = "recordLinkGroup" - UNIT = "unit" - CONSTANT = "constant" - PERMISSION = "permission" - PERMISSIONCATEGORY = "permissionCategory" - ACCESSCONTROLCATEGORY = "accessControlCategory" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_equation_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_equation_unit_error_detail.py deleted file mode 100644 index dce7fc3b7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_equation_unit_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaEquationUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "errors": "list[GsaUnitEquationErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaUnitEquationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.EQUATION, - errors: "list[GsaUnitEquationErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaEquationUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - errors: list[GsaUnitEquationErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaUnitEquationErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaUnitEquationErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaEquationUnitErrorDetail. - - Returns - ------- - list[GsaUnitEquationErrorDetail] | None | Unset_Type - The errors of this GsaEquationUnitErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquationErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaEquationUnitErrorDetail. - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] | None | Unset_Type - The errors of this GsaEquationUnitErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaEquationUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_code.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_code.py deleted file mode 100644 index 8e218ac35..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_code.py +++ /dev/null @@ -1,117 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaErrorCode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNKNOWN = "unknown" - ACCESSDENIED = "accessDenied" - ADDDATABASE = "addDatabase" - ATTRIBUTECREATION = "attributeCreation" - DATAVALIDATION = "dataValidation" - DELETERECORDVERSIONCONTROL = "deleteRecordVersionControl" - DELETION = "deletion" - DISCRETEVALUEAGGREGATE = "discreteValueAggregate" - DISPLAYNAMESIMPORT = "displayNamesImport" - FILECREATION = "fileCreation" - FILEMOVE = "fileMove" - FILEUPDATE = "fileUpdate" - FOLDERCREATION = "folderCreation" - FOLDERDELETION = "folderDeletion" - FOLDERMOVE = "folderMove" - FOLDERUPDATE = "folderUpdate" - GETMODIFIABLERECORDVERSIONCONTROL = "getModifiableRecordVersionControl" - IMAGETYPEVALIDATION = "imageTypeValidation" - INPUTVALIDATION = "inputValidation" - INTERNALSERVERERROR = "internalServerError" - JSONSERIALIZATION = "jsonSerialization" - NOSUCHENTITY = "noSuchEntity" - NOSUCHITEM = "noSuchItem" - NOTIMPLEMENTED = "notImplemented" - NOTSPECIFIED = "notSpecified" - NOTSUPPORTED = "notSupported" - PARAMETERCREATION = "parameterCreation" - PARAMETERUPDATE = "parameterUpdate" - PARAMETERVALUECREATION = "parameterValueCreation" - PARAMETERVALUEUPDATE = "parameterValueUpdate" - RECORDHISTORYCOPY = "recordHistoryCopy" - RECORDHISTORYCREATE = "recordHistoryCreate" - RECORDHISTORYMOVE = "recordHistoryMove" - RECORDLINKGROUPCREATION = "recordLinkGroupCreation" - RECORDLINKGROUPUPDATE = "recordLinkGroupUpdate" - RECORDLISTPUBLISH = "recordListPublish" - RECORDLISTRESETAWAITINGAPPROVAL = "recordListResetAwaitingApproval" - RECORDLISTSETAWAITINGAPPROVAL = "recordListSetAwaitingApproval" - RECORDLISTSETPERMISSIONS = "recordListSetPermissions" - RECORDLISTUNPUBLISH = "recordListUnpublish" - RELEASERECORDVERSIONCONTROL = "releaseRecordVersionControl" - RELEASETABLEVERSIONCONTROL = "releaseTableVersionControl" - SUBTYPEDESERIALIZATION = "subtypeDeserialization" - SERVERNOTAVAILABLE = "serverNotAvailable" - UPGRADEDATABASE = "upgradeDatabase" - WITHDRAWRECORDVERSIONCONTROL = "withdrawRecordVersionControl" - RECORDNOTMODIFIABLE = "recordNotModifiable" - CONFLICTING = "conflicting" - CURRENCYCREATION = "currencyCreation" - CURRENCYUPDATE = "currencyUpdate" - CURRENCYIMPORT = "currencyImport" - CURRENCYIMPORTDUPLICATES = "currencyImportDuplicates" - UNITCREATION = "unitCreation" - UNITUPDATE = "unitUpdate" - CONSTANTCREATION = "constantCreation" - CONSTANTUPDATE = "constantUpdate" - STANDARDNAMECREATION = "standardNameCreation" - STANDARDNAMEUPDATE = "standardNameUpdate" - STANDARDNAMEDELETION = "standardNameDeletion" - PERMISSIONCREATION = "permissionCreation" - PERMISSIONUPDATE = "permissionUpdate" - PERMISSIONDELETION = "permissionDeletion" - PERMISSIONCATEGORYCREATION = "permissionCategoryCreation" - PERMISSIONCATEGORYUPDATE = "permissionCategoryUpdate" - PERMISSIONCATEGORYDELETION = "permissionCategoryDeletion" - PERMISSIONCATEGORYREPLACE = "permissionCategoryReplace" - PERMISSIONCATEGORIESACCESSCONTROLUPDATE = "permissionCategoriesAccessControlUpdate" - ACCESSCONTROLCATEGORYCREATION = "accessControlCategoryCreation" - ACCESSCONTROLCATEGORYUPDATE = "accessControlCategoryUpdate" - GETUNITEQUIVALENTS = "getUnitEquivalents" - SETUNITEQUIVALENTS = "setUnitEquivalents" - TABLECREATION = "tableCreation" - TABLEUPDATE = "tableUpdate" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_exception_information.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_exception_information.py deleted file mode 100644 index a19ba0e6c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_exception_information.py +++ /dev/null @@ -1,293 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaExceptionInformation(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "exception_type_full_name": "str", - "localised_message": "str", - "message": "str", - "stringified_exception": "str", - "inner_exception_info": "GsaExceptionInformation", - } - - attribute_map: dict[str, str] = { - "exception_type_full_name": "exceptionTypeFullName", - "localised_message": "localisedMessage", - "message": "message", - "stringified_exception": "stringifiedException", - "inner_exception_info": "innerExceptionInfo", - } - - subtype_mapping: dict[str, str] = { - "innerExceptionInfo": "GsaExceptionInformation", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - exception_type_full_name: "str", - localised_message: "str", - message: "str", - stringified_exception: "str", - inner_exception_info: "GsaExceptionInformation | Unset_Type" = Unset, - ) -> None: - """GsaExceptionInformation - a model defined in Swagger - - Parameters - ---------- - exception_type_full_name: str - localised_message: str - message: str - stringified_exception: str - inner_exception_info: GsaExceptionInformation, optional - """ - self._exception_type_full_name: str - self._message: str - self._localised_message: str - self._stringified_exception: str - self._inner_exception_info: GsaExceptionInformation | Unset_Type = Unset - - self.exception_type_full_name = exception_type_full_name - self.message = message - self.localised_message = localised_message - self.stringified_exception = stringified_exception - if inner_exception_info is not Unset: - self.inner_exception_info = inner_exception_info - - @property - def exception_type_full_name(self) -> "str": - """Gets the exception_type_full_name of this GsaExceptionInformation. - Full type name of the original exception. - - Returns - ------- - str - The exception_type_full_name of this GsaExceptionInformation. - """ - return self._exception_type_full_name - - @exception_type_full_name.setter - def exception_type_full_name(self, exception_type_full_name: "str") -> None: - """Sets the exception_type_full_name of this GsaExceptionInformation. - Full type name of the original exception. - - Parameters - ---------- - exception_type_full_name: str - The exception_type_full_name of this GsaExceptionInformation. - """ - # Field is not nullable - if exception_type_full_name is None: - raise ValueError("Invalid value for 'exception_type_full_name', must not be 'None'") - # Field is required - if exception_type_full_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'exception_type_full_name', must not be 'Unset'") - self._exception_type_full_name = exception_type_full_name - - @property - def message(self) -> "str": - """Gets the message of this GsaExceptionInformation. - Message of the original exception. - - Returns - ------- - str - The message of this GsaExceptionInformation. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaExceptionInformation. - Message of the original exception. - - Parameters - ---------- - message: str - The message of this GsaExceptionInformation. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def localised_message(self) -> "str": - """Gets the localised_message of this GsaExceptionInformation. - Localised message of the original exception if available. Regular message of the original exception otherwise. - - Returns - ------- - str - The localised_message of this GsaExceptionInformation. - """ - return self._localised_message - - @localised_message.setter - def localised_message(self, localised_message: "str") -> None: - """Sets the localised_message of this GsaExceptionInformation. - Localised message of the original exception if available. Regular message of the original exception otherwise. - - Parameters - ---------- - localised_message: str - The localised_message of this GsaExceptionInformation. - """ - # Field is not nullable - if localised_message is None: - raise ValueError("Invalid value for 'localised_message', must not be 'None'") - # Field is required - if localised_message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'localised_message', must not be 'Unset'") - self._localised_message = localised_message - - @property - def stringified_exception(self) -> "str": - """Gets the stringified_exception of this GsaExceptionInformation. - The result of calling .ToString() on the original exception. - - Returns - ------- - str - The stringified_exception of this GsaExceptionInformation. - """ - return self._stringified_exception - - @stringified_exception.setter - def stringified_exception(self, stringified_exception: "str") -> None: - """Sets the stringified_exception of this GsaExceptionInformation. - The result of calling .ToString() on the original exception. - - Parameters - ---------- - stringified_exception: str - The stringified_exception of this GsaExceptionInformation. - """ - # Field is not nullable - if stringified_exception is None: - raise ValueError("Invalid value for 'stringified_exception', must not be 'None'") - # Field is required - if stringified_exception is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'stringified_exception', must not be 'Unset'") - self._stringified_exception = stringified_exception - - @property - def inner_exception_info(self) -> "GsaExceptionInformation | Unset_Type": - """Gets the inner_exception_info of this GsaExceptionInformation. - - Returns - ------- - GsaExceptionInformation | Unset_Type - The inner_exception_info of this GsaExceptionInformation. - """ - return self._inner_exception_info - - @inner_exception_info.setter - def inner_exception_info( - self, inner_exception_info: "GsaExceptionInformation | Unset_Type" - ) -> None: - """Sets the inner_exception_info of this GsaExceptionInformation. - - Parameters - ---------- - inner_exception_info: GsaExceptionInformation | Unset_Type - The inner_exception_info of this GsaExceptionInformation. - """ - # Field is not nullable - if inner_exception_info is None: - raise ValueError("Invalid value for 'inner_exception_info', must not be 'None'") - self._inner_exception_info = inner_exception_info - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaExceptionInformation): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression.py index ade7bf0a3..c20f3cbdc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression.py @@ -66,7 +66,6 @@ class GsaExpression(ModelBase): "guid": "str", "name": "str", "parameter_dependencies": "list[GsaSlimNamedEntity]", - "table": "GsaSlimEntity", "value": "str", "unit": "GsaSlimUnit", } @@ -77,7 +76,6 @@ class GsaExpression(ModelBase): "guid": "guid", "name": "name", "parameter_dependencies": "parameterDependencies", - "table": "table", "value": "value", "unit": "unit", } @@ -87,7 +85,6 @@ class GsaExpression(ModelBase): "attributeDependencies": "GsaSlimAttribute", "constantDependencies": "GsaSlimNamedEntity", "parameterDependencies": "GsaSlimNamedEntity", - "table": "GsaSlimEntity", } discriminator: Optional[str] = None @@ -100,7 +97,6 @@ def __init__( guid: "str", name: "str", parameter_dependencies: "list[GsaSlimNamedEntity]", - table: "GsaSlimEntity", value: "str", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: @@ -113,7 +109,6 @@ def __init__( guid: str name: str parameter_dependencies: list[GsaSlimNamedEntity] - table: GsaSlimEntity value: str unit: GsaSlimUnit, optional """ @@ -122,7 +117,6 @@ def __init__( self._attribute_dependencies: list[GsaSlimAttribute] self._constant_dependencies: list[GsaSlimNamedEntity] self._parameter_dependencies: list[GsaSlimNamedEntity] - self._table: GsaSlimEntity self._name: str self._guid: str @@ -132,7 +126,6 @@ def __init__( self.attribute_dependencies = attribute_dependencies self.constant_dependencies = constant_dependencies self.parameter_dependencies = parameter_dependencies - self.table = table self.name = name self.guid = guid @@ -273,34 +266,6 @@ def parameter_dependencies(self, parameter_dependencies: "list[GsaSlimNamedEntit raise ValueError("Invalid value for 'parameter_dependencies', must not be 'Unset'") self._parameter_dependencies = parameter_dependencies - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaExpression. - - Returns - ------- - GsaSlimEntity - The table of this GsaExpression. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaExpression. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaExpression. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - @property def name(self) -> "str": """Gets the name of this GsaExpression. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression_usage_data_modification_error_detail.py index fc254b2fb..51c7d0da9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_expression_usage_data_modification_error_detail.py @@ -74,7 +74,7 @@ class GsaExpressionUsageDataModificationErrorDetail(GsaUsageDataModificationErro "message": "str", "reason": "GsaDataModificationErrorReason", "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimExpression]", + "referenced_by": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -85,7 +85,7 @@ class GsaExpressionUsageDataModificationErrorDetail(GsaUsageDataModificationErro } subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimExpression", + "referencedBy": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -96,7 +96,7 @@ def __init__( message: "str", reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.EXPRESSION, - referenced_by: "list[GsaSlimExpression] | None | Unset_Type" = Unset, + referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, ) -> None: """GsaExpressionUsageDataModificationErrorDetail - a model defined in Swagger @@ -105,32 +105,32 @@ def __init__( message: str reason: GsaDataModificationErrorReason referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimExpression] | None, optional + referenced_by: list[GsaSlimNamedEntity] | None, optional """ super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimExpression] | None | Unset_Type = Unset + self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset if referenced_by is not Unset: self.referenced_by = referenced_by @property - def referenced_by(self) -> "list[GsaSlimExpression] | None | Unset_Type": + def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": """Gets the referenced_by of this GsaExpressionUsageDataModificationErrorDetail. Returns ------- - list[GsaSlimExpression] | None | Unset_Type + list[GsaSlimNamedEntity] | None | Unset_Type The referenced_by of this GsaExpressionUsageDataModificationErrorDetail. """ return self._referenced_by @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimExpression] | None | Unset_Type") -> None: + def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: """Sets the referenced_by of this GsaExpressionUsageDataModificationErrorDetail. Parameters ---------- - referenced_by: list[GsaSlimExpression] | None | Unset_Type + referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type The referenced_by of this GsaExpressionUsageDataModificationErrorDetail. """ self._referenced_by = referenced_by diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_already_exists_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_already_exists_file_move_error_detail.py deleted file mode 100644 index f361ab4aa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_already_exists_file_move_error_detail.py +++ /dev/null @@ -1,190 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileAlreadyExistsFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "name": "str", - "parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - "parent_folder_guid": "parentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.FILEALREADYEXISTS, - name: "str | None | Unset_Type" = Unset, - parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaFileAlreadyExistsFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - name: str | None, optional - parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._parent_folder_guid: str | Unset_Type = Unset - - if name is not Unset: - self.name = name - if parent_folder_guid is not Unset: - self.parent_folder_guid = parent_folder_guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - self._name = name - - @property - def parent_folder_guid(self) -> "str | Unset_Type": - """Gets the parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - return self._parent_folder_guid - - @parent_folder_guid.setter - def parent_folder_guid(self, parent_folder_guid: "str | Unset_Type") -> None: - """Sets the parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - - Parameters - ---------- - parent_folder_guid: str | Unset_Type - The parent_folder_guid of this GsaFileAlreadyExistsFileMoveErrorDetail. - """ - # Field is not nullable - if parent_folder_guid is None: - raise ValueError("Invalid value for 'parent_folder_guid', must not be 'None'") - self._parent_folder_guid = parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileAlreadyExistsFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_attribute.py index ceac63c88..7c4a1765a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_attribute.py @@ -69,7 +69,6 @@ class GsaFileAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaFileAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.FILE, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_creation_exception.py deleted file mode 100644 index ba125b139..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_creation_exception.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileErrorDetail]", - "folder_type": "GsaFolderType", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_type": "folderType", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileErrorDetail] | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileErrorDetail] | None, optional - folder_type: GsaFolderType, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileCreationException. - """ - self._name = name - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileCreationException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileCreationException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileCreationException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileCreationException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileCreationException. - - Returns - ------- - list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileCreationException. - - Parameters - ---------- - errors: list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_detail.py deleted file mode 100644 index 54b877b55..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFileErrorReason", - } - - discriminator_value_class_map = { - "configInvalidJson".lower(): "#/components/schemas/GsaConfigInvalidJsonFileErrorDetail", - "descriptionLength".lower(): "#/components/schemas/GsaDescriptionLengthFileErrorDetail", - "fileName".lower(): "#/components/schemas/GsaFileNameFileErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityFileErrorDetail", - "noData".lower(): "#/components/schemas/GsaNoDataFileErrorDetail", - "noFile".lower(): "#/components/schemas/GsaNoFileFileErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason", - ) -> None: - """GsaFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - self._message: str - self._reason: GsaFileErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFileErrorDetail. - - Returns - ------- - str - The message of this GsaFileErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFileErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFileErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFileErrorReason": - """Gets the reason of this GsaFileErrorDetail. - - Returns - ------- - GsaFileErrorReason - The reason of this GsaFileErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFileErrorReason") -> None: - """Sets the reason of this GsaFileErrorDetail. - - Parameters - ---------- - reason: GsaFileErrorReason - The reason of this GsaFileErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_reason.py deleted file mode 100644 index e74dcd54a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFileErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CONFIGINVALIDJSON = "configInvalidJson" - DESCRIPTIONLENGTH = "descriptionLength" - FILENAME = "fileName" - NAMEDENTITY = "namedEntity" - NODATA = "noData" - NOFILE = "noFile" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_header_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_header_info.py deleted file mode 100644 index f934fac80..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_header_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileHeaderInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "file_headers": "list[GsaFileHeader]", - } - - attribute_map: dict[str, str] = { - "file_headers": "fileHeaders", - } - - subtype_mapping: dict[str, str] = { - "fileHeaders": "GsaFileHeader", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - file_headers: "list[GsaFileHeader]", - ) -> None: - """GsaFileHeaderInfo - a model defined in Swagger - - Parameters - ---------- - file_headers: list[GsaFileHeader] - """ - self._file_headers: list[GsaFileHeader] - - self.file_headers = file_headers - - @property - def file_headers(self) -> "list[GsaFileHeader]": - """Gets the file_headers of this GsaFileHeaderInfo. - - Returns - ------- - list[GsaFileHeader] - The file_headers of this GsaFileHeaderInfo. - """ - return self._file_headers - - @file_headers.setter - def file_headers(self, file_headers: "list[GsaFileHeader]") -> None: - """Sets the file_headers of this GsaFileHeaderInfo. - - Parameters - ---------- - file_headers: list[GsaFileHeader] - The file_headers of this GsaFileHeaderInfo. - """ - # Field is not nullable - if file_headers is None: - raise ValueError("Invalid value for 'file_headers', must not be 'None'") - # Field is required - if file_headers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'file_headers', must not be 'Unset'") - self._file_headers = file_headers - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileHeaderInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_detail.py deleted file mode 100644 index fa665fa6e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileMoveErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFileMoveErrorReason", - } - - discriminator_value_class_map = { - "fileAlreadyExists".lower(): "#/components/schemas/GsaFileAlreadyExistsFileMoveErrorDetail", - "noSuchNewParent".lower(): "#/components/schemas/GsaNoSuchNewParentFileMoveErrorDetail", - "sameParent".lower(): "#/components/schemas/GsaSameParentFileMoveErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason", - ) -> None: - """GsaFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - """ - self._message: str - self._reason: GsaFileMoveErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFileMoveErrorDetail. - - Returns - ------- - str - The message of this GsaFileMoveErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFileMoveErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFileMoveErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFileMoveErrorReason": - """Gets the reason of this GsaFileMoveErrorDetail. - - Returns - ------- - GsaFileMoveErrorReason - The reason of this GsaFileMoveErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFileMoveErrorReason") -> None: - """Sets the reason of this GsaFileMoveErrorDetail. - - Parameters - ---------- - reason: GsaFileMoveErrorReason - The reason of this GsaFileMoveErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_reason.py deleted file mode 100644 index 01924935f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFileMoveErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FILEALREADYEXISTS = "fileAlreadyExists" - NOSUCHNEWPARENT = "noSuchNewParent" - SAMEPARENT = "sameParent" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_exception.py deleted file mode 100644 index dd58931a7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_move_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileMoveException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileMoveErrorDetail]", - "file_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "file_guid": "fileGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileMoveErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileMoveErrorDetail] | None | Unset_Type" = Unset, - file_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileMoveException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileMoveErrorDetail] | None, optional - file_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._file_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileMoveErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if file_guid is not Unset: - self.file_guid = file_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileMoveException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileMoveException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileMoveException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileMoveException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileMoveException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileMoveException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileMoveException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileMoveException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def file_guid(self) -> "str | Unset_Type": - """Gets the file_guid of this GsaFileMoveException. - - Returns - ------- - str | Unset_Type - The file_guid of this GsaFileMoveException. - """ - return self._file_guid - - @file_guid.setter - def file_guid(self, file_guid: "str | Unset_Type") -> None: - """Sets the file_guid of this GsaFileMoveException. - - Parameters - ---------- - file_guid: str | Unset_Type - The file_guid of this GsaFileMoveException. - """ - # Field is not nullable - if file_guid is None: - raise ValueError("Invalid value for 'file_guid', must not be 'None'") - self._file_guid = file_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileMoveException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileMoveException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileMoveException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileMoveException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileMoveErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileMoveException. - - Returns - ------- - list[GsaFileMoveErrorDetail] | None | Unset_Type - The errors of this GsaFileMoveException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileMoveErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileMoveException. - - Parameters - ---------- - errors: list[GsaFileMoveErrorDetail] | None | Unset_Type - The errors of this GsaFileMoveException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileMoveException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_file_error_detail.py deleted file mode 100644 index 1d3b633f7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_file_error_detail.py +++ /dev/null @@ -1,156 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileNameFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.FILENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileNameFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileNameFileErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileNameFileErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileNameFileErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileNameFileErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileNameFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_folder_error_detail.py deleted file mode 100644 index 1abe3a52b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_name_folder_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileNameFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.FILENAME, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileNameFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFileNameFolderErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFileNameFolderErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFileNameFolderErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFileNameFolderErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileNameFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_update_exception.py deleted file mode 100644 index 22c53727e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_file_update_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFileUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFileErrorDetail]", - "file_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "file_guid": "fileGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFileErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFileErrorDetail] | None | Unset_Type" = Unset, - file_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFileUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFileErrorDetail] | None, optional - file_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._file_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFileErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if file_guid is not Unset: - self.file_guid = file_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFileUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFileUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFileUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFileUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFileUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFileUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFileUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFileUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def file_guid(self) -> "str | Unset_Type": - """Gets the file_guid of this GsaFileUpdateException. - - Returns - ------- - str | Unset_Type - The file_guid of this GsaFileUpdateException. - """ - return self._file_guid - - @file_guid.setter - def file_guid(self, file_guid: "str | Unset_Type") -> None: - """Sets the file_guid of this GsaFileUpdateException. - - Parameters - ---------- - file_guid: str | Unset_Type - The file_guid of this GsaFileUpdateException. - """ - # Field is not nullable - if file_guid is None: - raise ValueError("Invalid value for 'file_guid', must not be 'None'") - self._file_guid = file_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFileUpdateException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFileUpdateException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFileUpdateException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFileUpdateException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFileErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFileUpdateException. - - Returns - ------- - list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFileErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFileUpdateException. - - Parameters - ---------- - errors: list[GsaFileErrorDetail] | None | Unset_Type - The errors of this GsaFileUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFileUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_additional_sql_parameters.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_search_request.py similarity index 77% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_additional_sql_parameters.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_search_request.py index c3fd61fdd..815c70785 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_additional_sql_parameters.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaAdditionalSqlParameters(ModelBase): +class GsaFindSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,11 +61,11 @@ class GsaAdditionalSqlParameters(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "value": "str", + "name_contains": "str", } attribute_map: dict[str, str] = { - "value": "value", + "name_contains": "nameContains", } subtype_mapping: dict[str, str] = {} @@ -75,40 +75,40 @@ class GsaAdditionalSqlParameters(ModelBase): def __init__( self, *, - value: "str | None | Unset_Type" = Unset, + name_contains: "str | None | Unset_Type" = Unset, ) -> None: - """GsaAdditionalSqlParameters - a model defined in Swagger + """GsaFindSearchRequest - a model defined in Swagger Parameters ---------- - value: str | None, optional + name_contains: str | None, optional """ - self._value: str | None | Unset_Type = Unset + self._name_contains: str | None | Unset_Type = Unset - if value is not Unset: - self.value = value + if name_contains is not Unset: + self.name_contains = name_contains @property - def value(self) -> "str | None | Unset_Type": - """Gets the value of this GsaAdditionalSqlParameters. + def name_contains(self) -> "str | None | Unset_Type": + """Gets the name_contains of this GsaFindSearchRequest. Returns ------- str | None | Unset_Type - The value of this GsaAdditionalSqlParameters. + The name_contains of this GsaFindSearchRequest. """ - return self._value + return self._name_contains - @value.setter - def value(self, value: "str | None | Unset_Type") -> None: - """Sets the value of this GsaAdditionalSqlParameters. + @name_contains.setter + def name_contains(self, name_contains: "str | None | Unset_Type") -> None: + """Sets the name_contains of this GsaFindSearchRequest. Parameters ---------- - value: str | None | Unset_Type - The value of this GsaAdditionalSqlParameters. + name_contains: str | None | Unset_Type + The name_contains of this GsaFindSearchRequest. """ - self._value = value + self._name_contains = name_contains @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -132,7 +132,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaAdditionalSqlParameters): + if not isinstance(other, GsaFindSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_request.py deleted file mode 100644 index 2220a632e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "similarity_settings": "GsaSimilaritySettings", - "criterion": "GsaFindSimilarSearchCriterion", - } - - attribute_map: dict[str, str] = { - "similarity_settings": "similaritySettings", - "criterion": "criterion", - } - - subtype_mapping: dict[str, str] = { - "similaritySettings": "GsaSimilaritySettings", - "criterion": "GsaFindSimilarSearchCriterion", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - similarity_settings: "GsaSimilaritySettings", - criterion: "GsaFindSimilarSearchCriterion | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarRequest - a model defined in Swagger - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings - criterion: GsaFindSimilarSearchCriterion, optional - """ - self._similarity_settings: GsaSimilaritySettings - self._criterion: GsaFindSimilarSearchCriterion | Unset_Type = Unset - - self.similarity_settings = similarity_settings - if criterion is not Unset: - self.criterion = criterion - - @property - def similarity_settings(self) -> "GsaSimilaritySettings": - """Gets the similarity_settings of this GsaFindSimilarRequest. - - Returns - ------- - GsaSimilaritySettings - The similarity_settings of this GsaFindSimilarRequest. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings(self, similarity_settings: "GsaSimilaritySettings") -> None: - """Sets the similarity_settings of this GsaFindSimilarRequest. - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings - The similarity_settings of this GsaFindSimilarRequest. - """ - # Field is not nullable - if similarity_settings is None: - raise ValueError("Invalid value for 'similarity_settings', must not be 'None'") - # Field is required - if similarity_settings is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'similarity_settings', must not be 'Unset'") - self._similarity_settings = similarity_settings - - @property - def criterion(self) -> "GsaFindSimilarSearchCriterion | Unset_Type": - """Gets the criterion of this GsaFindSimilarRequest. - - Returns - ------- - GsaFindSimilarSearchCriterion | Unset_Type - The criterion of this GsaFindSimilarRequest. - """ - return self._criterion - - @criterion.setter - def criterion(self, criterion: "GsaFindSimilarSearchCriterion | Unset_Type") -> None: - """Sets the criterion of this GsaFindSimilarRequest. - - Parameters - ---------- - criterion: GsaFindSimilarSearchCriterion | Unset_Type - The criterion of this GsaFindSimilarRequest. - """ - # Field is not nullable - if criterion is None: - raise ValueError("Invalid value for 'criterion', must not be 'None'") - self._criterion = criterion - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_response.py deleted file mode 100644 index c5710e9e6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_response.py +++ /dev/null @@ -1,247 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "calculation_complete": "bool", - "error": "GsaErrorResponse", - "find_similar_id": "str", - "results": "list[GsaFindSimilarResult]", - } - - attribute_map: dict[str, str] = { - "calculation_complete": "calculationComplete", - "error": "error", - "find_similar_id": "findSimilarId", - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "results": "GsaFindSimilarResult", - "error": "GsaErrorResponse", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - calculation_complete: "bool | Unset_Type" = Unset, - error: "GsaErrorResponse | Unset_Type" = Unset, - find_similar_id: "str | Unset_Type" = Unset, - results: "list[GsaFindSimilarResult] | None | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarResponse - a model defined in Swagger - - Parameters - ---------- - calculation_complete: bool, optional - error: GsaErrorResponse, optional - find_similar_id: str, optional - results: list[GsaFindSimilarResult] | None, optional - """ - self._find_similar_id: str | Unset_Type = Unset - self._calculation_complete: bool | Unset_Type = Unset - self._results: list[GsaFindSimilarResult] | None | Unset_Type = Unset - self._error: GsaErrorResponse | Unset_Type = Unset - - if find_similar_id is not Unset: - self.find_similar_id = find_similar_id - if calculation_complete is not Unset: - self.calculation_complete = calculation_complete - if results is not Unset: - self.results = results - if error is not Unset: - self.error = error - - @property - def find_similar_id(self) -> "str | Unset_Type": - """Gets the find_similar_id of this GsaFindSimilarResponse. - The Identifier of the find similar calculation - - Returns - ------- - str | Unset_Type - The find_similar_id of this GsaFindSimilarResponse. - """ - return self._find_similar_id - - @find_similar_id.setter - def find_similar_id(self, find_similar_id: "str | Unset_Type") -> None: - """Sets the find_similar_id of this GsaFindSimilarResponse. - The Identifier of the find similar calculation - - Parameters - ---------- - find_similar_id: str | Unset_Type - The find_similar_id of this GsaFindSimilarResponse. - """ - # Field is not nullable - if find_similar_id is None: - raise ValueError("Invalid value for 'find_similar_id', must not be 'None'") - self._find_similar_id = find_similar_id - - @property - def calculation_complete(self) -> "bool | Unset_Type": - """Gets the calculation_complete of this GsaFindSimilarResponse. - Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.FindSimilarResponse.Results will only be populated if this is true. - - Returns - ------- - bool | Unset_Type - The calculation_complete of this GsaFindSimilarResponse. - """ - return self._calculation_complete - - @calculation_complete.setter - def calculation_complete(self, calculation_complete: "bool | Unset_Type") -> None: - """Sets the calculation_complete of this GsaFindSimilarResponse. - Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.FindSimilarResponse.Results will only be populated if this is true. - - Parameters - ---------- - calculation_complete: bool | Unset_Type - The calculation_complete of this GsaFindSimilarResponse. - """ - # Field is not nullable - if calculation_complete is None: - raise ValueError("Invalid value for 'calculation_complete', must not be 'None'") - self._calculation_complete = calculation_complete - - @property - def results(self) -> "list[GsaFindSimilarResult] | None | Unset_Type": - """Gets the results of this GsaFindSimilarResponse. - Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.FindSimilarResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.FindSimilarResponse.Error is not set. - - Returns - ------- - list[GsaFindSimilarResult] | None | Unset_Type - The results of this GsaFindSimilarResponse. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaFindSimilarResult] | None | Unset_Type") -> None: - """Sets the results of this GsaFindSimilarResponse. - Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.FindSimilarResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.FindSimilarResponse.Error is not set. - - Parameters - ---------- - results: list[GsaFindSimilarResult] | None | Unset_Type - The results of this GsaFindSimilarResponse. - """ - self._results = results - - @property - def error(self) -> "GsaErrorResponse | Unset_Type": - """Gets the error of this GsaFindSimilarResponse. - - Returns - ------- - GsaErrorResponse | Unset_Type - The error of this GsaFindSimilarResponse. - """ - return self._error - - @error.setter - def error(self, error: "GsaErrorResponse | Unset_Type") -> None: - """Sets the error of this GsaFindSimilarResponse. - - Parameters - ---------- - error: GsaErrorResponse | Unset_Type - The error of this GsaFindSimilarResponse. - """ - # Field is not nullable - if error is None: - raise ValueError("Invalid value for 'error', must not be 'None'") - self._error = error - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_result.py deleted file mode 100644 index df01b5268..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_result.py +++ /dev/null @@ -1,177 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_guid": "str", - "score": "float", - } - - attribute_map: dict[str, str] = { - "record_guid": "recordGuid", - "score": "score", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_guid: "str | Unset_Type" = Unset, - score: "float | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarResult - a model defined in Swagger - - Parameters - ---------- - record_guid: str, optional - score: float, optional - """ - self._record_guid: str | Unset_Type = Unset - self._score: float | Unset_Type = Unset - - if record_guid is not Unset: - self.record_guid = record_guid - if score is not Unset: - self.score = score - - @property - def record_guid(self) -> "str | Unset_Type": - """Gets the record_guid of this GsaFindSimilarResult. - - Returns - ------- - str | Unset_Type - The record_guid of this GsaFindSimilarResult. - """ - return self._record_guid - - @record_guid.setter - def record_guid(self, record_guid: "str | Unset_Type") -> None: - """Sets the record_guid of this GsaFindSimilarResult. - - Parameters - ---------- - record_guid: str | Unset_Type - The record_guid of this GsaFindSimilarResult. - """ - # Field is not nullable - if record_guid is None: - raise ValueError("Invalid value for 'record_guid', must not be 'None'") - self._record_guid = record_guid - - @property - def score(self) -> "float | Unset_Type": - """Gets the score of this GsaFindSimilarResult. - - Returns - ------- - float | Unset_Type - The score of this GsaFindSimilarResult. - """ - return self._score - - @score.setter - def score(self, score: "float | Unset_Type") -> None: - """Sets the score of this GsaFindSimilarResult. - - Parameters - ---------- - score: float | Unset_Type - The score of this GsaFindSimilarResult. - """ - # Field is not nullable - if score is None: - raise ValueError("Invalid value for 'score', must not be 'None'") - self._score = score - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_search_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_search_criterion.py deleted file mode 100644 index e587b5fed..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_find_similar_search_criterion.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFindSimilarSearchCriterion(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_type_criterion": "GsaRecordTypeCriterion", - "subset_criterion": "GsaRecordSubsetCriterion", - } - - attribute_map: dict[str, str] = { - "record_type_criterion": "recordTypeCriterion", - "subset_criterion": "subsetCriterion", - } - - subtype_mapping: dict[str, str] = { - "subsetCriterion": "GsaRecordSubsetCriterion", - "recordTypeCriterion": "GsaRecordTypeCriterion", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_type_criterion: "GsaRecordTypeCriterion | Unset_Type" = Unset, - subset_criterion: "GsaRecordSubsetCriterion | Unset_Type" = Unset, - ) -> None: - """GsaFindSimilarSearchCriterion - a model defined in Swagger - - Parameters - ---------- - record_type_criterion: GsaRecordTypeCriterion, optional - subset_criterion: GsaRecordSubsetCriterion, optional - """ - self._subset_criterion: GsaRecordSubsetCriterion | Unset_Type = Unset - self._record_type_criterion: GsaRecordTypeCriterion | Unset_Type = Unset - - if subset_criterion is not Unset: - self.subset_criterion = subset_criterion - if record_type_criterion is not Unset: - self.record_type_criterion = record_type_criterion - - @property - def subset_criterion(self) -> "GsaRecordSubsetCriterion | Unset_Type": - """Gets the subset_criterion of this GsaFindSimilarSearchCriterion. - - Returns - ------- - GsaRecordSubsetCriterion | Unset_Type - The subset_criterion of this GsaFindSimilarSearchCriterion. - """ - return self._subset_criterion - - @subset_criterion.setter - def subset_criterion(self, subset_criterion: "GsaRecordSubsetCriterion | Unset_Type") -> None: - """Sets the subset_criterion of this GsaFindSimilarSearchCriterion. - - Parameters - ---------- - subset_criterion: GsaRecordSubsetCriterion | Unset_Type - The subset_criterion of this GsaFindSimilarSearchCriterion. - """ - # Field is not nullable - if subset_criterion is None: - raise ValueError("Invalid value for 'subset_criterion', must not be 'None'") - self._subset_criterion = subset_criterion - - @property - def record_type_criterion(self) -> "GsaRecordTypeCriterion | Unset_Type": - """Gets the record_type_criterion of this GsaFindSimilarSearchCriterion. - - Returns - ------- - GsaRecordTypeCriterion | Unset_Type - The record_type_criterion of this GsaFindSimilarSearchCriterion. - """ - return self._record_type_criterion - - @record_type_criterion.setter - def record_type_criterion( - self, record_type_criterion: "GsaRecordTypeCriterion | Unset_Type" - ) -> None: - """Sets the record_type_criterion of this GsaFindSimilarSearchCriterion. - - Parameters - ---------- - record_type_criterion: GsaRecordTypeCriterion | Unset_Type - The record_type_criterion of this GsaFindSimilarSearchCriterion. - """ - # Field is not nullable - if record_type_criterion is None: - raise ValueError("Invalid value for 'record_type_criterion', must not be 'None'") - self._record_type_criterion = record_type_criterion - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFindSimilarSearchCriterion): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_float_functional_attribute.py index 1644b9759..60f15e525 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_float_functional_attribute.py @@ -70,7 +70,6 @@ class GsaFloatFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_range": "bool", "name": "str", "table": "GsaSlimEntity", @@ -88,7 +87,6 @@ class GsaFloatFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_range": "isRange", "name": "name", "table": "table", @@ -115,7 +113,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_range: "bool", name: "str", table: "GsaSlimEntity", @@ -135,7 +132,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_range: bool name: str table: GsaSlimEntity @@ -151,7 +147,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder.py index aa64d67df..c9bb5849a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder.py @@ -63,16 +63,12 @@ class GsaFolder(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "has_child_folders": "bool", - "has_files": "bool", "parent_guid": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "has_child_folders": "hasChildFolders", - "has_files": "hasFiles", "parent_guid": "parentGuid", } @@ -85,8 +81,6 @@ def __init__( *, guid: "str", name: "str", - has_child_folders: "bool | Unset_Type" = Unset, - has_files: "bool | Unset_Type" = Unset, parent_guid: "str | None | Unset_Type" = Unset, ) -> None: """GsaFolder - a model defined in Swagger @@ -95,22 +89,14 @@ def __init__( ---------- guid: str name: str - has_child_folders: bool, optional - has_files: bool, optional parent_guid: str | None, optional """ self._parent_guid: str | None | Unset_Type = Unset - self._has_files: bool | Unset_Type = Unset - self._has_child_folders: bool | Unset_Type = Unset self._name: str self._guid: str if parent_guid is not Unset: self.parent_guid = parent_guid - if has_files is not Unset: - self.has_files = has_files - if has_child_folders is not Unset: - self.has_child_folders = has_child_folders self.name = name self.guid = guid @@ -136,56 +122,6 @@ def parent_guid(self, parent_guid: "str | None | Unset_Type") -> None: """ self._parent_guid = parent_guid - @property - def has_files(self) -> "bool | Unset_Type": - """Gets the has_files of this GsaFolder. - - Returns - ------- - bool | Unset_Type - The has_files of this GsaFolder. - """ - return self._has_files - - @has_files.setter - def has_files(self, has_files: "bool | Unset_Type") -> None: - """Sets the has_files of this GsaFolder. - - Parameters - ---------- - has_files: bool | Unset_Type - The has_files of this GsaFolder. - """ - # Field is not nullable - if has_files is None: - raise ValueError("Invalid value for 'has_files', must not be 'None'") - self._has_files = has_files - - @property - def has_child_folders(self) -> "bool | Unset_Type": - """Gets the has_child_folders of this GsaFolder. - - Returns - ------- - bool | Unset_Type - The has_child_folders of this GsaFolder. - """ - return self._has_child_folders - - @has_child_folders.setter - def has_child_folders(self, has_child_folders: "bool | Unset_Type") -> None: - """Sets the has_child_folders of this GsaFolder. - - Parameters - ---------- - has_child_folders: bool | Unset_Type - The has_child_folders of this GsaFolder. - """ - # Field is not nullable - if has_child_folders is None: - raise ValueError("Invalid value for 'has_child_folders', must not be 'None'") - self._has_child_folders = has_child_folders - @property def name(self) -> "str": """Gets the name of this GsaFolder. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_creation_exception.py deleted file mode 100644 index 6cf7ae093..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_creation_exception.py +++ /dev/null @@ -1,268 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderErrorDetail]", - "folder_type": "GsaFolderType", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_type": "folderType", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderErrorDetail] | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderErrorDetail] | None, optional - folder_type: GsaFolderType, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFolderCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaFolderCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFolderCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaFolderCreationException. - """ - self._name = name - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderCreationException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderCreationException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderCreationException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderCreationException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderCreationException. - - Returns - ------- - list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderCreationException. - - Parameters - ---------- - errors: list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_detail.py deleted file mode 100644 index aee1343ba..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_detail.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderDeletionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderDeletionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderDeletionErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderDeletionErrorReason | Unset_Type" = Unset, - ) -> None: - """GsaFolderDeletionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderDeletionErrorReason, optional - """ - self._message: str - self._reason: GsaFolderDeletionErrorReason | Unset_Type = Unset - - self.message = message - if reason is not Unset: - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFolderDeletionErrorDetail. - - Returns - ------- - str - The message of this GsaFolderDeletionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFolderDeletionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFolderDeletionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFolderDeletionErrorReason | Unset_Type": - """Gets the reason of this GsaFolderDeletionErrorDetail. - - Returns - ------- - GsaFolderDeletionErrorReason | Unset_Type - The reason of this GsaFolderDeletionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFolderDeletionErrorReason | Unset_Type") -> None: - """Sets the reason of this GsaFolderDeletionErrorDetail. - - Parameters - ---------- - reason: GsaFolderDeletionErrorReason | Unset_Type - The reason of this GsaFolderDeletionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderDeletionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_reason.py deleted file mode 100644 index 2b4cedc1b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ROOT = "root" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_exception.py deleted file mode 100644 index bffa1bfcf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_deletion_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderDeletionErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderDeletionErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderDeletionException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderDeletionErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderDeletionException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderDeletionException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderDeletionException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderDeletionException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderDeletionException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderDeletionException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderDeletionException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderDeletionException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderDeletionException. - - Returns - ------- - list[GsaFolderDeletionErrorDetail] | None | Unset_Type - The errors of this GsaFolderDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderDeletionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderDeletionException. - - Parameters - ---------- - errors: list[GsaFolderDeletionErrorDetail] | None | Unset_Type - The errors of this GsaFolderDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_detail.py deleted file mode 100644 index e7fd1f734..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderErrorReason", - } - - discriminator_value_class_map = { - "fileName".lower(): "#/components/schemas/GsaFileNameFolderErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityFolderErrorDetail", - "updateRoot".lower(): "#/components/schemas/GsaUpdateRootFolderErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason", - ) -> None: - """GsaFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - """ - self._message: str - self._reason: GsaFolderErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFolderErrorDetail. - - Returns - ------- - str - The message of this GsaFolderErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFolderErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFolderErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFolderErrorReason": - """Gets the reason of this GsaFolderErrorDetail. - - Returns - ------- - GsaFolderErrorReason - The reason of this GsaFolderErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFolderErrorReason") -> None: - """Sets the reason of this GsaFolderErrorDetail. - - Parameters - ---------- - reason: GsaFolderErrorReason - The reason of this GsaFolderErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_reason.py deleted file mode 100644 index 5d9809f60..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FILENAME = "fileName" - NAMEDENTITY = "namedEntity" - UPDATEROOT = "updateRoot" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_detail.py deleted file mode 100644 index e74217630..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderMoveErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaFolderMoveErrorReason", - } - - discriminator_value_class_map = { - "circularReference".lower(): "#/components/schemas/GsaCircularReferenceFolderMoveErrorDetail", - "folderAlreadyExists".lower(): "#/components/schemas/GsaFolderAlreadyExistsFolderMoveErrorDetail", - "noSuchNewParent".lower(): "#/components/schemas/GsaNoSuchNewParentFolderMoveErrorDetail", - "root".lower(): "#/components/schemas/GsaRootFolderMoveErrorDetail", - "sameParent".lower(): "#/components/schemas/GsaSameParentFolderMoveErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason", - ) -> None: - """GsaFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - self._message: str - self._reason: GsaFolderMoveErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaFolderMoveErrorDetail. - - Returns - ------- - str - The message of this GsaFolderMoveErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaFolderMoveErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaFolderMoveErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaFolderMoveErrorReason": - """Gets the reason of this GsaFolderMoveErrorDetail. - - Returns - ------- - GsaFolderMoveErrorReason - The reason of this GsaFolderMoveErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaFolderMoveErrorReason") -> None: - """Sets the reason of this GsaFolderMoveErrorDetail. - - Parameters - ---------- - reason: GsaFolderMoveErrorReason - The reason of this GsaFolderMoveErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_reason.py deleted file mode 100644 index 3823b1199..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_error_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderMoveErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CIRCULARREFERENCE = "circularReference" - FOLDERALREADYEXISTS = "folderAlreadyExists" - NOSUCHNEWPARENT = "noSuchNewParent" - ROOT = "root" - SAMEPARENT = "sameParent" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_exception.py deleted file mode 100644 index f81827fcc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_move_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderMoveException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderMoveErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderMoveErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderMoveErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderMoveException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderMoveErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderMoveErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderMoveException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderMoveException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderMoveException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderMoveException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderMoveException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderMoveException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderMoveException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderMoveException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderMoveException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderMoveException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderMoveException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderMoveException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderMoveException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderMoveException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderMoveException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderMoveException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderMoveErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderMoveException. - - Returns - ------- - list[GsaFolderMoveErrorDetail] | None | Unset_Type - The errors of this GsaFolderMoveException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderMoveErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderMoveException. - - Parameters - ---------- - errors: list[GsaFolderMoveErrorDetail] | None | Unset_Type - The errors of this GsaFolderMoveException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderMoveException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_type.py deleted file mode 100644 index 2454afc16..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_type.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaFolderType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - HOMEPAGE = "homePage" - HELPPAGE = "helpPage" - EXPORTER = "exporter" - CONFIGURATION = "configuration" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_update_exception.py deleted file mode 100644 index 3829e372e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_update_exception.py +++ /dev/null @@ -1,271 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFolderUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaFolderErrorDetail]", - "folder_guid": "str", - "folder_type": "GsaFolderType", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "folder_guid": "folderGuid", - "folder_type": "folderType", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "folderType": "GsaFolderType", - "errors": "GsaFolderErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaFolderErrorDetail] | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaFolderUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaFolderErrorDetail] | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._errors: list[GsaFolderErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaFolderUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaFolderUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaFolderUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaFolderUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaFolderUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaFolderUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaFolderUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaFolderUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaFolderUpdateException. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaFolderUpdateException. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaFolderUpdateException. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaFolderUpdateException. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaFolderUpdateException. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaFolderUpdateException. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaFolderUpdateException. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaFolderUpdateException. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def errors(self) -> "list[GsaFolderErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaFolderUpdateException. - - Returns - ------- - list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaFolderErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaFolderUpdateException. - - Parameters - ---------- - errors: list[GsaFolderErrorDetail] | None | Unset_Type - The errors of this GsaFolderUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_forbid_orphans_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_forbid_orphans_record_link_group_error_detail.py deleted file mode 100644 index 12469e421..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_forbid_orphans_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaForbidOrphansRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.FORBIDORPHANS, - ) -> None: - """GsaForbidOrphansRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaForbidOrphansRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_functional_data_default_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_functional_data_default_usage_data_modification_error_detail.py deleted file mode 100644 index e3ce4cea2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_functional_data_default_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaFunctionalDataDefaultUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.FUNCTIONALDATADEFAULT, - ) -> None: - """GsaFunctionalDataDefaultUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaFunctionalDataDefaultUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_general_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_general_unit_equation_error_detail.py deleted file mode 100644 index 5db4ce6f9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_general_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGeneralUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.GENERAL, - ) -> None: - """GsaGeneralUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGeneralUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_modifiable_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_modifiable_record_version_control_exception.py index bf49b8b77..92df4bcd0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_modifiable_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_modifiable_record_version_control_exception.py @@ -61,7 +61,7 @@ class GsaGetModifiableRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaGetModifiableRecordVersionControlException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -82,7 +82,7 @@ class GsaGetModifiableRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaGetModifiableRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaGetModifiableRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaGetModifiableRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaGetModifiableRecordVersionControlException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_conversions_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_conversions_request.py index 8752d7998..b8a46ed89 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_conversions_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_conversions_request.py @@ -61,15 +61,15 @@ class GsaGetUnitConversionsRequest(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "conversions": "list[GsaUnitConversionSetRequest]", + "source_units": "list[GsaUnitConversionSetRequest]", } attribute_map: dict[str, str] = { - "conversions": "conversions", + "source_units": "sourceUnits", } subtype_mapping: dict[str, str] = { - "conversions": "GsaUnitConversionSetRequest", + "sourceUnits": "GsaUnitConversionSetRequest", } discriminator: Optional[str] = None @@ -77,45 +77,45 @@ class GsaGetUnitConversionsRequest(ModelBase): def __init__( self, *, - conversions: "list[GsaUnitConversionSetRequest]", + source_units: "list[GsaUnitConversionSetRequest]", ) -> None: """GsaGetUnitConversionsRequest - a model defined in Swagger Parameters ---------- - conversions: list[GsaUnitConversionSetRequest] + source_units: list[GsaUnitConversionSetRequest] """ - self._conversions: list[GsaUnitConversionSetRequest] + self._source_units: list[GsaUnitConversionSetRequest] - self.conversions = conversions + self.source_units = source_units @property - def conversions(self) -> "list[GsaUnitConversionSetRequest]": - """Gets the conversions of this GsaGetUnitConversionsRequest. + def source_units(self) -> "list[GsaUnitConversionSetRequest]": + """Gets the source_units of this GsaGetUnitConversionsRequest. Returns ------- list[GsaUnitConversionSetRequest] - The conversions of this GsaGetUnitConversionsRequest. + The source_units of this GsaGetUnitConversionsRequest. """ - return self._conversions + return self._source_units - @conversions.setter - def conversions(self, conversions: "list[GsaUnitConversionSetRequest]") -> None: - """Sets the conversions of this GsaGetUnitConversionsRequest. + @source_units.setter + def source_units(self, source_units: "list[GsaUnitConversionSetRequest]") -> None: + """Sets the source_units of this GsaGetUnitConversionsRequest. Parameters ---------- - conversions: list[GsaUnitConversionSetRequest] - The conversions of this GsaGetUnitConversionsRequest. + source_units: list[GsaUnitConversionSetRequest] + The source_units of this GsaGetUnitConversionsRequest. """ # Field is not nullable - if conversions is None: - raise ValueError("Invalid value for 'conversions', must not be 'None'") + if source_units is None: + raise ValueError("Invalid value for 'source_units', must not be 'None'") # Field is required - if conversions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'conversions', must not be 'Unset'") - self._conversions = conversions + if source_units is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'source_units', must not be 'Unset'") + self._source_units = source_units @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_equivalents_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_equivalents_exception.py deleted file mode 100644 index dad4a8e72..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_get_unit_equivalents_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGetUnitEquivalentsException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaUnitEquivalentErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitEquivalentErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaGetUnitEquivalentsException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaUnitEquivalentErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaGetUnitEquivalentsException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaGetUnitEquivalentsException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaGetUnitEquivalentsException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaGetUnitEquivalentsException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaGetUnitEquivalentsException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaGetUnitEquivalentsException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaGetUnitEquivalentsException. - - Returns - ------- - list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaGetUnitEquivalentsException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaGetUnitEquivalentsException. - - Parameters - ---------- - errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaGetUnitEquivalentsException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGetUnitEquivalentsException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_grid.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_grid.py deleted file mode 100644 index 3e47def17..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_grid.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaGrid(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "headers": "list[str]", - "rows": "list[list[str]]", - } - - attribute_map: dict[str, str] = { - "headers": "headers", - "rows": "rows", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - headers: "list[str]", - rows: "list[list[str]]", - ) -> None: - """GsaGrid - a model defined in Swagger - - Parameters - ---------- - headers: list[str] - rows: list[list[str]] - """ - self._headers: list[str] - self._rows: list[list[str]] - - self.headers = headers - self.rows = rows - - @property - def headers(self) -> "list[str]": - """Gets the headers of this GsaGrid. - - Returns - ------- - list[str] - The headers of this GsaGrid. - """ - return self._headers - - @headers.setter - def headers(self, headers: "list[str]") -> None: - """Sets the headers of this GsaGrid. - - Parameters - ---------- - headers: list[str] - The headers of this GsaGrid. - """ - # Field is not nullable - if headers is None: - raise ValueError("Invalid value for 'headers', must not be 'None'") - # Field is required - if headers is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'headers', must not be 'Unset'") - self._headers = headers - - @property - def rows(self) -> "list[list[str]]": - """Gets the rows of this GsaGrid. - - Returns - ------- - list[list[str]] - The rows of this GsaGrid. - """ - return self._rows - - @rows.setter - def rows(self, rows: "list[list[str]]") -> None: - """Sets the rows of this GsaGrid. - - Parameters - ---------- - rows: list[list[str]] - The rows of this GsaGrid. - """ - # Field is not nullable - if rows is None: - raise ValueError("Invalid value for 'rows', must not be 'None'") - # Field is required - if rows is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'rows', must not be 'Unset'") - self._rows = rows - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaGrid): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_guid_only_integration_schema_of_object_identifier.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_guid_only_integration_schema_of_object_identifier.py index 543becda9..fb4d7d48b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_guid_only_integration_schema_of_object_identifier.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_guid_only_integration_schema_of_object_identifier.py @@ -67,7 +67,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "str", "layouts": "list[GsaGuidOnlyLayout]", "security_groups": "GsaSecurityGroups", - "similarity_settings": "GsaSimilaritySettings", "sources": "list[GsaGuidOnlySourceOfObjectIdentifier]", "unit_system": "str", "version": "int", @@ -80,7 +79,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "key", "layouts": "layouts", "security_groups": "securityGroups", - "similarity_settings": "similaritySettings", "sources": "sources", "unit_system": "unitSystem", "version": "version", @@ -92,7 +90,6 @@ class GsaGuidOnlyIntegrationSchemaOfObjectIdentifier(ModelBase): "discreteTypes": "GsaGuidOnlyDiscreteType", "sources": "GsaGuidOnlySourceOfObjectIdentifier", "securityGroups": "GsaSecurityGroups", - "similaritySettings": "GsaSimilaritySettings", } discriminator: Optional[str] = None @@ -106,7 +103,6 @@ def __init__( key: "str | None | Unset_Type" = Unset, layouts: "list[GsaGuidOnlyLayout] | None | Unset_Type" = Unset, security_groups: "GsaSecurityGroups | Unset_Type" = Unset, - similarity_settings: "GsaSimilaritySettings | Unset_Type" = Unset, sources: "list[GsaGuidOnlySourceOfObjectIdentifier] | None | Unset_Type" = Unset, unit_system: "str | None | Unset_Type" = Unset, version: "int | None | Unset_Type" = Unset, @@ -121,7 +117,6 @@ def __init__( key: str | None, optional layouts: list[GsaGuidOnlyLayout] | None, optional security_groups: GsaSecurityGroups, optional - similarity_settings: GsaSimilaritySettings, optional sources: list[GsaGuidOnlySourceOfObjectIdentifier] | None, optional unit_system: str | None, optional version: int | None, optional @@ -135,7 +130,6 @@ def __init__( self._sources: list[GsaGuidOnlySourceOfObjectIdentifier] | None | Unset_Type = Unset self._access_control_category_values: dict[str, list[str]] | None | Unset_Type = Unset self._security_groups: GsaSecurityGroups | Unset_Type = Unset - self._similarity_settings: GsaSimilaritySettings | Unset_Type = Unset if key is not Unset: self.key = key @@ -155,8 +149,6 @@ def __init__( self.access_control_category_values = access_control_category_values if security_groups is not Unset: self.security_groups = security_groups - if similarity_settings is not Unset: - self.similarity_settings = similarity_settings @property def key(self) -> "str | None | Unset_Type": @@ -365,33 +357,6 @@ def security_groups(self, security_groups: "GsaSecurityGroups | Unset_Type") -> raise ValueError("Invalid value for 'security_groups', must not be 'None'") self._security_groups = security_groups - @property - def similarity_settings(self) -> "GsaSimilaritySettings | Unset_Type": - """Gets the similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - - Returns - ------- - GsaSimilaritySettings | Unset_Type - The similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings( - self, similarity_settings: "GsaSimilaritySettings | Unset_Type" - ) -> None: - """Sets the similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings | Unset_Type - The similarity_settings of this GsaGuidOnlyIntegrationSchemaOfObjectIdentifier. - """ - # Field is not nullable - if similarity_settings is None: - raise ValueError("Invalid value for 'similarity_settings', must not be 'None'") - self._similarity_settings = similarity_settings - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_help_paths_validation_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_help_paths_validation_response.py deleted file mode 100644 index fa1a97769..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_help_paths_validation_response.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaHelpPathsValidationResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attributes": "list[GsaSlimAttributeWithHelpPath]", - "parameters": "list[GsaSlimParameterWithHelpPath]", - } - - attribute_map: dict[str, str] = { - "attributes": "attributes", - "parameters": "parameters", - } - - subtype_mapping: dict[str, str] = { - "attributes": "GsaSlimAttributeWithHelpPath", - "parameters": "GsaSlimParameterWithHelpPath", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attributes: "list[GsaSlimAttributeWithHelpPath]", - parameters: "list[GsaSlimParameterWithHelpPath]", - ) -> None: - """GsaHelpPathsValidationResponse - a model defined in Swagger - - Parameters - ---------- - attributes: list[GsaSlimAttributeWithHelpPath] - parameters: list[GsaSlimParameterWithHelpPath] - """ - self._attributes: list[GsaSlimAttributeWithHelpPath] - self._parameters: list[GsaSlimParameterWithHelpPath] - - self.attributes = attributes - self.parameters = parameters - - @property - def attributes(self) -> "list[GsaSlimAttributeWithHelpPath]": - """Gets the attributes of this GsaHelpPathsValidationResponse. - - Returns - ------- - list[GsaSlimAttributeWithHelpPath] - The attributes of this GsaHelpPathsValidationResponse. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttributeWithHelpPath]") -> None: - """Sets the attributes of this GsaHelpPathsValidationResponse. - - Parameters - ---------- - attributes: list[GsaSlimAttributeWithHelpPath] - The attributes of this GsaHelpPathsValidationResponse. - """ - # Field is not nullable - if attributes is None: - raise ValueError("Invalid value for 'attributes', must not be 'None'") - # Field is required - if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attributes', must not be 'Unset'") - self._attributes = attributes - - @property - def parameters(self) -> "list[GsaSlimParameterWithHelpPath]": - """Gets the parameters of this GsaHelpPathsValidationResponse. - - Returns - ------- - list[GsaSlimParameterWithHelpPath] - The parameters of this GsaHelpPathsValidationResponse. - """ - return self._parameters - - @parameters.setter - def parameters(self, parameters: "list[GsaSlimParameterWithHelpPath]") -> None: - """Sets the parameters of this GsaHelpPathsValidationResponse. - - Parameters - ---------- - parameters: list[GsaSlimParameterWithHelpPath] - The parameters of this GsaHelpPathsValidationResponse. - """ - # Field is not nullable - if parameters is None: - raise ValueError("Invalid value for 'parameters', must not be 'None'") - # Field is required - if parameters is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'parameters', must not be 'Unset'") - self._parameters = parameters - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaHelpPathsValidationResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_hyperlink_attribute.py index 6722471af..9ed7bb1f9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_hyperlink_attribute.py @@ -69,7 +69,6 @@ class GsaHyperlinkAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaHyperlinkAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.HYPERLINK, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_in_use_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_in_use_parameter_value_error_detail.py deleted file mode 100644 index 7c5d20716..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_in_use_parameter_value_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInUseParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "parameter_value_guid": "str", - "used_by_type": "GsaParameterValueUsedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "parameter_value_guid": "parameterValueGuid", - "used_by_type": "usedByType", - } - - subtype_mapping: dict[str, str] = { - "usedByType": "GsaParameterValueUsedByType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.INUSE, - parameter_value_guid: "str | Unset_Type" = Unset, - used_by_type: "GsaParameterValueUsedByType | Unset_Type" = Unset, - ) -> None: - """GsaInUseParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - parameter_value_guid: str, optional - used_by_type: GsaParameterValueUsedByType, optional - """ - super().__init__(message=message, reason=reason) - self._parameter_value_guid: str | Unset_Type = Unset - self._used_by_type: GsaParameterValueUsedByType | Unset_Type = Unset - - if parameter_value_guid is not Unset: - self.parameter_value_guid = parameter_value_guid - if used_by_type is not Unset: - self.used_by_type = used_by_type - - @property - def parameter_value_guid(self) -> "str | Unset_Type": - """Gets the parameter_value_guid of this GsaInUseParameterValueErrorDetail. - - Returns - ------- - str | Unset_Type - The parameter_value_guid of this GsaInUseParameterValueErrorDetail. - """ - return self._parameter_value_guid - - @parameter_value_guid.setter - def parameter_value_guid(self, parameter_value_guid: "str | Unset_Type") -> None: - """Sets the parameter_value_guid of this GsaInUseParameterValueErrorDetail. - - Parameters - ---------- - parameter_value_guid: str | Unset_Type - The parameter_value_guid of this GsaInUseParameterValueErrorDetail. - """ - # Field is not nullable - if parameter_value_guid is None: - raise ValueError("Invalid value for 'parameter_value_guid', must not be 'None'") - self._parameter_value_guid = parameter_value_guid - - @property - def used_by_type(self) -> "GsaParameterValueUsedByType | Unset_Type": - """Gets the used_by_type of this GsaInUseParameterValueErrorDetail. - - Returns - ------- - GsaParameterValueUsedByType | Unset_Type - The used_by_type of this GsaInUseParameterValueErrorDetail. - """ - return self._used_by_type - - @used_by_type.setter - def used_by_type(self, used_by_type: "GsaParameterValueUsedByType | Unset_Type") -> None: - """Sets the used_by_type of this GsaInUseParameterValueErrorDetail. - - Parameters - ---------- - used_by_type: GsaParameterValueUsedByType | Unset_Type - The used_by_type of this GsaInUseParameterValueErrorDetail. - """ - # Field is not nullable - if used_by_type is None: - raise ValueError("Invalid value for 'used_by_type', must not be 'None'") - self._used_by_type = used_by_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInUseParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_inclusiveness.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_inclusiveness.py deleted file mode 100644 index 1e144c33d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_inclusiveness.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaInclusiveness(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INCLUSIVE = "inclusive" - EXCLUSIVE = "exclusive" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_incompatible_units_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_incompatible_units_error_detail.py deleted file mode 100644 index 53969be8c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_incompatible_units_error_detail.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaIncompatibleUnitsErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "equivalent_unit_guid": "str", - "unit_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.INCOMPATIBLEUNITS, - equivalent_unit_guid: "str | Unset_Type" = Unset, - unit_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaIncompatibleUnitsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - equivalent_unit_guid: str, optional - unit_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._unit_guid: str | Unset_Type = Unset - self._equivalent_unit_guid: str | Unset_Type = Unset - - if unit_guid is not Unset: - self.unit_guid = unit_guid - if equivalent_unit_guid is not Unset: - self.equivalent_unit_guid = equivalent_unit_guid - - @property - def unit_guid(self) -> "str | Unset_Type": - """Gets the unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str | Unset_Type") -> None: - """Sets the unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Parameters - ---------- - unit_guid: str | Unset_Type - The unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - self._unit_guid = unit_guid - - @property - def equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str | Unset_Type") -> None: - """Sets the equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - - Parameters - ---------- - equivalent_unit_guid: str | Unset_Type - The equivalent_unit_guid of this GsaIncompatibleUnitsErrorDetail. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - self._equivalent_unit_guid = equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaIncompatibleUnitsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_input_connection_details.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_input_connection_details.py deleted file mode 100644 index a3fe62ae0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_input_connection_details.py +++ /dev/null @@ -1,324 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInputConnectionDetails(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "data_source": "str", - "initial_catalog": "str", - "additional_sql_parameters": "str", - "sql_credentials": "GsaSqlCredentials", - "use_configuration_database_credentials": "bool", - "use_integrated_security": "bool", - } - - attribute_map: dict[str, str] = { - "data_source": "dataSource", - "initial_catalog": "initialCatalog", - "additional_sql_parameters": "additionalSqlParameters", - "sql_credentials": "sqlCredentials", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", - "use_integrated_security": "useIntegratedSecurity", - } - - subtype_mapping: dict[str, str] = { - "sqlCredentials": "GsaSqlCredentials", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - data_source: "str", - initial_catalog: "str", - additional_sql_parameters: "str | None | Unset_Type" = Unset, - sql_credentials: "GsaSqlCredentials | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | Unset_Type" = Unset, - use_integrated_security: "bool | Unset_Type" = Unset, - ) -> None: - """GsaInputConnectionDetails - a model defined in Swagger - - Parameters - ---------- - data_source: str - initial_catalog: str - additional_sql_parameters: str | None, optional - sql_credentials: GsaSqlCredentials, optional - use_configuration_database_credentials: bool, optional - use_integrated_security: bool, optional - """ - self._data_source: str - self._initial_catalog: str - self._use_configuration_database_credentials: bool | Unset_Type = Unset - self._use_integrated_security: bool | Unset_Type = Unset - self._sql_credentials: GsaSqlCredentials | Unset_Type = Unset - self._additional_sql_parameters: str | None | Unset_Type = Unset - - self.data_source = data_source - self.initial_catalog = initial_catalog - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials - if use_integrated_security is not Unset: - self.use_integrated_security = use_integrated_security - if sql_credentials is not Unset: - self.sql_credentials = sql_credentials - if additional_sql_parameters is not Unset: - self.additional_sql_parameters = additional_sql_parameters - - @property - def data_source(self) -> "str": - """Gets the data_source of this GsaInputConnectionDetails. - The SQL server data source - - Returns - ------- - str - The data_source of this GsaInputConnectionDetails. - """ - return self._data_source - - @data_source.setter - def data_source(self, data_source: "str") -> None: - """Sets the data_source of this GsaInputConnectionDetails. - The SQL server data source - - Parameters - ---------- - data_source: str - The data_source of this GsaInputConnectionDetails. - """ - # Field is not nullable - if data_source is None: - raise ValueError("Invalid value for 'data_source', must not be 'None'") - # Field is required - if data_source is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'data_source', must not be 'Unset'") - self._data_source = data_source - - @property - def initial_catalog(self) -> "str": - """Gets the initial_catalog of this GsaInputConnectionDetails. - The name of the database in SQL server - - Returns - ------- - str - The initial_catalog of this GsaInputConnectionDetails. - """ - return self._initial_catalog - - @initial_catalog.setter - def initial_catalog(self, initial_catalog: "str") -> None: - """Sets the initial_catalog of this GsaInputConnectionDetails. - The name of the database in SQL server - - Parameters - ---------- - initial_catalog: str - The initial_catalog of this GsaInputConnectionDetails. - """ - # Field is not nullable - if initial_catalog is None: - raise ValueError("Invalid value for 'initial_catalog', must not be 'None'") - # Field is required - if initial_catalog is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'initial_catalog', must not be 'Unset'") - self._initial_catalog = initial_catalog - - @property - def use_configuration_database_credentials(self) -> "bool | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaInputConnectionDetails. - Set to true if the SQL connection should use the credentials from the Configuration database. - - Returns - ------- - bool | Unset_Type - The use_configuration_database_credentials of this GsaInputConnectionDetails. - """ - return self._use_configuration_database_credentials - - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaInputConnectionDetails. - Set to true if the SQL connection should use the credentials from the Configuration database. - - Parameters - ---------- - use_configuration_database_credentials: bool | Unset_Type - The use_configuration_database_credentials of this GsaInputConnectionDetails. - """ - # Field is not nullable - if use_configuration_database_credentials is None: - raise ValueError( - "Invalid value for 'use_configuration_database_credentials', must not be 'None'" - ) - self._use_configuration_database_credentials = use_configuration_database_credentials - - @property - def use_integrated_security(self) -> "bool | Unset_Type": - """Gets the use_integrated_security of this GsaInputConnectionDetails. - Set to true if the SQL connection to the database should use Windows authentication - - Returns - ------- - bool | Unset_Type - The use_integrated_security of this GsaInputConnectionDetails. - """ - return self._use_integrated_security - - @use_integrated_security.setter - def use_integrated_security(self, use_integrated_security: "bool | Unset_Type") -> None: - """Sets the use_integrated_security of this GsaInputConnectionDetails. - Set to true if the SQL connection to the database should use Windows authentication - - Parameters - ---------- - use_integrated_security: bool | Unset_Type - The use_integrated_security of this GsaInputConnectionDetails. - """ - # Field is not nullable - if use_integrated_security is None: - raise ValueError("Invalid value for 'use_integrated_security', must not be 'None'") - self._use_integrated_security = use_integrated_security - - @property - def sql_credentials(self) -> "GsaSqlCredentials | Unset_Type": - """Gets the sql_credentials of this GsaInputConnectionDetails. - - Returns - ------- - GsaSqlCredentials | Unset_Type - The sql_credentials of this GsaInputConnectionDetails. - """ - return self._sql_credentials - - @sql_credentials.setter - def sql_credentials(self, sql_credentials: "GsaSqlCredentials | Unset_Type") -> None: - """Sets the sql_credentials of this GsaInputConnectionDetails. - - Parameters - ---------- - sql_credentials: GsaSqlCredentials | Unset_Type - The sql_credentials of this GsaInputConnectionDetails. - """ - # Field is not nullable - if sql_credentials is None: - raise ValueError("Invalid value for 'sql_credentials', must not be 'None'") - self._sql_credentials = sql_credentials - - @property - def additional_sql_parameters(self) -> "str | None | Unset_Type": - """Gets the additional_sql_parameters of this GsaInputConnectionDetails. - (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. - - Returns - ------- - str | None | Unset_Type - The additional_sql_parameters of this GsaInputConnectionDetails. - """ - return self._additional_sql_parameters - - @additional_sql_parameters.setter - def additional_sql_parameters( - self, additional_sql_parameters: "str | None | Unset_Type" - ) -> None: - """Sets the additional_sql_parameters of this GsaInputConnectionDetails. - (Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format. - - Parameters - ---------- - additional_sql_parameters: str | None | Unset_Type - The additional_sql_parameters of this GsaInputConnectionDetails. - """ - self._additional_sql_parameters = additional_sql_parameters - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInputConnectionDetails): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_attribute.py index 1358923e4..0d54f4e85 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_attribute.py @@ -69,7 +69,6 @@ class GsaIntegerAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_unique": "bool", "name": "str", "table": "GsaSlimEntity", @@ -85,7 +84,6 @@ class GsaIntegerAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_unique": "isUnique", "name": "name", "table": "table", @@ -107,7 +105,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_unique: "bool", name: "str", table: "GsaSlimEntity", @@ -125,7 +122,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_unique: bool name: str table: GsaSlimEntity @@ -140,7 +136,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_chart_data.py deleted file mode 100644 index e549daa69..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integer_chart_data.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaIntegerChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - "value": "int", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.INTEGER, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "int | Unset_Type" = Unset, - ) -> None: - """GsaIntegerChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - value: int, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: int | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "int | Unset_Type": - """Gets the value of this GsaIntegerChartData. - - Returns - ------- - int | Unset_Type - The value of this GsaIntegerChartData. - """ - return self._value - - @value.setter - def value(self, value: "int | Unset_Type") -> None: - """Sets the value of this GsaIntegerChartData. - - Parameters - ---------- - value: int | Unset_Type - The value of this GsaIntegerChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaIntegerChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integration_schema_of_object_identifier.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integration_schema_of_object_identifier.py index 8e3b1eda2..7ee08d985 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integration_schema_of_object_identifier.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_integration_schema_of_object_identifier.py @@ -67,7 +67,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "str", "layouts": "list[GsaIntegrationLayout]", "security_groups": "GsaSecurityGroups", - "similarity_settings": "GsaSimilaritySettings", "sources": "list[GsaSourceOfObjectIdentifier]", "unit_system": "str", "version": "int", @@ -80,7 +79,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "key": "key", "layouts": "layouts", "security_groups": "securityGroups", - "similarity_settings": "similaritySettings", "sources": "sources", "unit_system": "unitSystem", "version": "version", @@ -92,7 +90,6 @@ class GsaIntegrationSchemaOfObjectIdentifier(ModelBase): "discreteTypes": "GsaIntegrationDiscreteType", "sources": "GsaSourceOfObjectIdentifier", "securityGroups": "GsaSecurityGroups", - "similaritySettings": "GsaSimilaritySettings", } discriminator: Optional[str] = None @@ -106,7 +103,6 @@ def __init__( key: "str | None | Unset_Type" = Unset, layouts: "list[GsaIntegrationLayout] | None | Unset_Type" = Unset, security_groups: "GsaSecurityGroups | Unset_Type" = Unset, - similarity_settings: "GsaSimilaritySettings | Unset_Type" = Unset, sources: "list[GsaSourceOfObjectIdentifier] | None | Unset_Type" = Unset, unit_system: "str | None | Unset_Type" = Unset, version: "int | None | Unset_Type" = Unset, @@ -121,7 +117,6 @@ def __init__( key: str | None, optional layouts: list[GsaIntegrationLayout] | None, optional security_groups: GsaSecurityGroups, optional - similarity_settings: GsaSimilaritySettings, optional sources: list[GsaSourceOfObjectIdentifier] | None, optional unit_system: str | None, optional version: int | None, optional @@ -135,7 +130,6 @@ def __init__( self._sources: list[GsaSourceOfObjectIdentifier] | None | Unset_Type = Unset self._access_control_category_values: dict[str, list[str]] | None | Unset_Type = Unset self._security_groups: GsaSecurityGroups | Unset_Type = Unset - self._similarity_settings: GsaSimilaritySettings | Unset_Type = Unset if key is not Unset: self.key = key @@ -155,8 +149,6 @@ def __init__( self.access_control_category_values = access_control_category_values if security_groups is not Unset: self.security_groups = security_groups - if similarity_settings is not Unset: - self.similarity_settings = similarity_settings @property def key(self) -> "str | None | Unset_Type": @@ -363,33 +355,6 @@ def security_groups(self, security_groups: "GsaSecurityGroups | Unset_Type") -> raise ValueError("Invalid value for 'security_groups', must not be 'None'") self._security_groups = security_groups - @property - def similarity_settings(self) -> "GsaSimilaritySettings | Unset_Type": - """Gets the similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - - Returns - ------- - GsaSimilaritySettings | Unset_Type - The similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - """ - return self._similarity_settings - - @similarity_settings.setter - def similarity_settings( - self, similarity_settings: "GsaSimilaritySettings | Unset_Type" - ) -> None: - """Sets the similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - - Parameters - ---------- - similarity_settings: GsaSimilaritySettings | Unset_Type - The similarity_settings of this GsaIntegrationSchemaOfObjectIdentifier. - """ - # Field is not nullable - if similarity_settings is None: - raise ValueError("Invalid value for 'similarity_settings', must not be 'None'") - self._similarity_settings = similarity_settings - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_equivalence_target_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_equivalence_target_error_detail.py deleted file mode 100644 index f08833f37..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_equivalence_target_error_detail.py +++ /dev/null @@ -1,261 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInvalidEquivalenceTargetErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "equivalent_of_equivalent_unit_guid": "str", - "equivalent_unit_guid": "str", - "unit_guid": "str", - "unit_system_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "equivalent_of_equivalent_unit_guid": "equivalentOfEquivalentUnitGuid", - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - "unit_system_guid": "unitSystemGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.INVALIDEQUIVALENCETARGET, - equivalent_of_equivalent_unit_guid: "str | Unset_Type" = Unset, - equivalent_unit_guid: "str | Unset_Type" = Unset, - unit_guid: "str | Unset_Type" = Unset, - unit_system_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaInvalidEquivalenceTargetErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - equivalent_of_equivalent_unit_guid: str, optional - equivalent_unit_guid: str, optional - unit_guid: str, optional - unit_system_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._unit_guid: str | Unset_Type = Unset - self._unit_system_guid: str | Unset_Type = Unset - self._equivalent_unit_guid: str | Unset_Type = Unset - self._equivalent_of_equivalent_unit_guid: str | Unset_Type = Unset - - if unit_guid is not Unset: - self.unit_guid = unit_guid - if unit_system_guid is not Unset: - self.unit_system_guid = unit_system_guid - if equivalent_unit_guid is not Unset: - self.equivalent_unit_guid = equivalent_unit_guid - if equivalent_of_equivalent_unit_guid is not Unset: - self.equivalent_of_equivalent_unit_guid = equivalent_of_equivalent_unit_guid - - @property - def unit_guid(self) -> "str | Unset_Type": - """Gets the unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str | Unset_Type") -> None: - """Sets the unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - unit_guid: str | Unset_Type - The unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - self._unit_guid = unit_guid - - @property - def unit_system_guid(self) -> "str | Unset_Type": - """Gets the unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._unit_system_guid - - @unit_system_guid.setter - def unit_system_guid(self, unit_system_guid: "str | Unset_Type") -> None: - """Sets the unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - unit_system_guid: str | Unset_Type - The unit_system_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if unit_system_guid is None: - raise ValueError("Invalid value for 'unit_system_guid', must not be 'None'") - self._unit_system_guid = unit_system_guid - - @property - def equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str | Unset_Type") -> None: - """Sets the equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - equivalent_unit_guid: str | Unset_Type - The equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - self._equivalent_unit_guid = equivalent_unit_guid - - @property - def equivalent_of_equivalent_unit_guid(self) -> "str | Unset_Type": - """Gets the equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Returns - ------- - str | Unset_Type - The equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - return self._equivalent_of_equivalent_unit_guid - - @equivalent_of_equivalent_unit_guid.setter - def equivalent_of_equivalent_unit_guid( - self, equivalent_of_equivalent_unit_guid: "str | Unset_Type" - ) -> None: - """Sets the equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - - Parameters - ---------- - equivalent_of_equivalent_unit_guid: str | Unset_Type - The equivalent_of_equivalent_unit_guid of this GsaInvalidEquivalenceTargetErrorDetail. - """ - # Field is not nullable - if equivalent_of_equivalent_unit_guid is None: - raise ValueError( - "Invalid value for 'equivalent_of_equivalent_unit_guid', must not be 'None'" - ) - self._equivalent_of_equivalent_unit_guid = equivalent_of_equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInvalidEquivalenceTargetErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_exchange_rate_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_exchange_rate_currency_error_detail.py deleted file mode 100644 index 71847ff4d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_invalid_exchange_rate_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaInvalidExchangeRateCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.INVALIDEXCHANGERATE, - ) -> None: - """GsaInvalidExchangeRateCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaInvalidExchangeRateCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout.py index 8f34cd94e..6433a2f0e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout.py @@ -174,7 +174,6 @@ def applicable_applications(self, applicable_applications: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -186,7 +185,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_attribute_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_attribute_item.py index b1d6a940e..7c4dbadfd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_attribute_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_attribute_item.py @@ -67,7 +67,6 @@ class GsaLayoutAttributeItem(GsaLayoutItem): """ swagger_types: dict[str, str] = { "attribute_type": "GsaAttributeType", - "display_names": "dict(str, str)", "guid": "str", "item_type": "GsaLayoutItemType", "name": "str", @@ -80,7 +79,6 @@ class GsaLayoutAttributeItem(GsaLayoutItem): attribute_map: dict[str, str] = { "attribute_type": "attributeType", - "display_names": "displayNames", "guid": "guid", "item_type": "itemType", "name": "name", @@ -103,7 +101,6 @@ def __init__( self, *, attribute_type: "GsaAttributeType", - display_names: "dict[str, str]", guid: "str", item_type: "GsaLayoutItemType" = GsaLayoutItemType.ATTRIBUTE, name: "str", @@ -118,7 +115,6 @@ def __init__( Parameters ---------- attribute_type: GsaAttributeType - display_names: dict[str, str] guid: str item_type: GsaLayoutItemType name: str @@ -129,11 +125,7 @@ def __init__( tabular_columns: list[GsaLayoutTabularColumn] | None, optional """ super().__init__( - display_names=display_names, - guid=guid, - item_type=item_type, - name=name, - underlying_entity_guid=underlying_entity_guid, + guid=guid, item_type=item_type, name=name, underlying_entity_guid=underlying_entity_guid ) self._attribute_type: GsaAttributeType self._required: bool diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_item.py index 76a721840..25f4f203b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_item.py @@ -63,7 +63,6 @@ class GsaLayoutItem(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "guid": "str", "item_type": "GsaLayoutItemType", "name": "str", @@ -71,7 +70,6 @@ class GsaLayoutItem(ModelBase): } attribute_map: dict[str, str] = { - "display_names": "displayNames", "guid": "guid", "item_type": "itemType", "name": "name", @@ -92,7 +90,6 @@ class GsaLayoutItem(ModelBase): def __init__( self, *, - display_names: "dict[str, str]", guid: "str", item_type: "GsaLayoutItemType", name: "str", @@ -102,7 +99,6 @@ def __init__( Parameters ---------- - display_names: dict[str, str] guid: str item_type: GsaLayoutItemType name: str @@ -110,13 +106,11 @@ def __init__( """ self._item_type: GsaLayoutItemType self._underlying_entity_guid: str - self._display_names: dict[str, str] self._name: str self._guid: str self.item_type = item_type self.underlying_entity_guid = underlying_entity_guid - self.display_names = display_names self.name = name self.guid = guid @@ -176,36 +170,6 @@ def underlying_entity_guid(self, underlying_entity_guid: "str") -> None: raise ValueError("Invalid value for 'underlying_entity_guid', must not be 'Unset'") self._underlying_entity_guid = underlying_entity_guid - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaLayoutItem. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaLayoutItem. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaLayoutItem. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaLayoutItem. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaLayoutItem. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_link_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_link_item.py index 6fb7a096c..8bb9fe4cc 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_link_item.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_link_item.py @@ -66,7 +66,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "forwards": "bool", "guid": "str", "item_type": "GsaLayoutItemType", @@ -80,7 +79,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): } attribute_map: dict[str, str] = { - "display_names": "displayNames", "forwards": "forwards", "guid": "guid", "item_type": "itemType", @@ -103,7 +101,6 @@ class GsaLayoutLinkItem(GsaLayoutItem): def __init__( self, *, - display_names: "dict[str, str]", forwards: "bool", guid: "str", item_type: "GsaLayoutItemType" = GsaLayoutItemType.LINK, @@ -119,7 +116,6 @@ def __init__( Parameters ---------- - display_names: dict[str, str] forwards: bool guid: str item_type: GsaLayoutItemType @@ -132,11 +128,7 @@ def __init__( target_database_version: str | None, optional """ super().__init__( - display_names=display_names, - guid=guid, - item_type=item_type, - name=name, - underlying_entity_guid=underlying_entity_guid, + guid=guid, item_type=item_type, name=name, underlying_entity_guid=underlying_entity_guid ) self._link_type: GsaLayoutItemLinkType self._target_database: str | None | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_section.py index 4cd9652e5..721480632 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_section.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_layout_section.py @@ -145,7 +145,6 @@ def section_detail_type(self, section_detail_type: "GsaLayoutSectionDetailType") @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaLayoutSection. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -157,7 +156,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaLayoutSection. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_attribute_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_attribute_type.py index b8356a8a5..109021128 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_attribute_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_attribute_type.py @@ -44,5 +44,5 @@ class GsaLinkAttributeType(Enum): """ RECORDLINK = "recordLink" CROSSDATABASELINK = "crossDatabaseLink" - SMARTLINK = "smartLink" + DYNAMICLINK = "dynamicLink" TABULARATTRIBUTE = "tabularAttribute" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_target.py index 5b1227c15..8f1f3c2d5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_target.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link_target.py @@ -61,15 +61,15 @@ class GsaLinkTarget(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "table_guid": "str", "database_guid": "str", "database_version_guid": "str", + "table_guid": "str", } attribute_map: dict[str, str] = { - "table_guid": "tableGuid", "database_guid": "databaseGuid", "database_version_guid": "databaseVersionGuid", + "table_guid": "tableGuid", } subtype_mapping: dict[str, str] = {} @@ -79,32 +79,32 @@ class GsaLinkTarget(ModelBase): def __init__( self, *, - table_guid: "str", database_guid: "str | None | Unset_Type" = Unset, database_version_guid: "str | None | Unset_Type" = Unset, + table_guid: "str | None | Unset_Type" = Unset, ) -> None: """GsaLinkTarget - a model defined in Swagger Parameters ---------- - table_guid: str database_guid: str | None, optional database_version_guid: str | None, optional + table_guid: str | None, optional """ self._database_guid: str | None | Unset_Type = Unset self._database_version_guid: str | None | Unset_Type = Unset - self._table_guid: str + self._table_guid: str | None | Unset_Type = Unset if database_guid is not Unset: self.database_guid = database_guid if database_version_guid is not Unset: self.database_version_guid = database_version_guid - self.table_guid = table_guid + if table_guid is not Unset: + self.table_guid = table_guid @property def database_guid(self) -> "str | None | Unset_Type": """Gets the database_guid of this GsaLinkTarget. - Gets the guid of the database that this link group is referencing. If `null` it means match any database with a matching table (only the case for cross database links) Returns ------- @@ -116,7 +116,6 @@ def database_guid(self) -> "str | None | Unset_Type": @database_guid.setter def database_guid(self, database_guid: "str | None | Unset_Type") -> None: """Sets the database_guid of this GsaLinkTarget. - Gets the guid of the database that this link group is referencing. If `null` it means match any database with a matching table (only the case for cross database links) Parameters ---------- @@ -128,7 +127,6 @@ def database_guid(self, database_guid: "str | None | Unset_Type") -> None: @property def database_version_guid(self) -> "str | None | Unset_Type": """Gets the database_version_guid of this GsaLinkTarget. - Database version GUID. Null for forwards cross database link targets. Returns ------- @@ -140,7 +138,6 @@ def database_version_guid(self) -> "str | None | Unset_Type": @database_version_guid.setter def database_version_guid(self, database_version_guid: "str | None | Unset_Type") -> None: """Sets the database_version_guid of this GsaLinkTarget. - Database version GUID. Null for forwards cross database link targets. Parameters ---------- @@ -150,31 +147,25 @@ def database_version_guid(self, database_version_guid: "str | None | Unset_Type" self._database_version_guid = database_version_guid @property - def table_guid(self) -> "str": + def table_guid(self) -> "str | None | Unset_Type": """Gets the table_guid of this GsaLinkTarget. Returns ------- - str + str | None | Unset_Type The table_guid of this GsaLinkTarget. """ return self._table_guid @table_guid.setter - def table_guid(self, table_guid: "str") -> None: + def table_guid(self, table_guid: "str | None | Unset_Type") -> None: """Sets the table_guid of this GsaLinkTarget. Parameters ---------- - table_guid: str + table_guid: str | None | Unset_Type The table_guid of this GsaLinkTarget. """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") self._table_guid = table_guid @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_attribute_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_attribute_tabular_column.py index b3c43cd5a..f9b4181b7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_attribute_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_attribute_tabular_column.py @@ -73,13 +73,11 @@ class GsaLinkedAttributeTabularColumn(GsaTabularColumn): "guid": "str", "linked_attribute": "GsaSlimAttribute", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLinkedAttributeTabularColumn(GsaTabularColumn): "guid": "guid", "linked_attribute": "linkedAttribute", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( guid: "str", linked_attribute: "GsaSlimAttribute", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLinkedAttributeTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( guid: str linked_attribute: GsaSlimAttribute name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._linked_attribute: GsaSlimAttribute diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_column_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_column_tabular_column.py index 7baf61989..a719f8dbb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_column_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_column_tabular_column.py @@ -74,13 +74,11 @@ class GsaLinkedColumnTabularColumn(GsaTabularColumn): "linked_attribute": "GsaSlimAttribute", "linked_column": "GsaTabularColumn", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "linked_target": "GsaTabularAttributeTarget", } @@ -91,13 +89,11 @@ class GsaLinkedColumnTabularColumn(GsaTabularColumn): "linked_attribute": "linkedAttribute", "linked_column": "linkedColumn", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "linked_target": "linkedTarget", } @@ -118,13 +114,11 @@ def __init__( linked_attribute: "GsaSlimAttribute", linked_column: "GsaTabularColumn", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", linked_target: "GsaTabularAttributeTarget | Unset_Type" = Unset, ) -> None: """GsaLinkedColumnTabularColumn - a model defined in Swagger @@ -137,13 +131,11 @@ def __init__( linked_attribute: GsaSlimAttribute linked_column: GsaTabularColumn name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] linked_target: GsaTabularAttributeTarget, optional """ super().__init__( @@ -151,13 +143,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._linked_attribute: GsaSlimAttribute self._linked_column: GsaTabularColumn diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_record_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_record_tabular_column.py index 9a2e0bb30..5fd514f06 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_record_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linked_record_tabular_column.py @@ -72,13 +72,11 @@ class GsaLinkedRecordTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -86,13 +84,11 @@ class GsaLinkedRecordTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = {} @@ -106,13 +102,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLinkedRecordTabularColumn - a model defined in Swagger @@ -122,26 +116,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linking_value_exists_datum_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linking_value_exists_datum_criterion.py index c6fe03c72..9426def84 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linking_value_exists_datum_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_linking_value_exists_datum_criterion.py @@ -88,7 +88,7 @@ class GsaLinkingValueExistsDatumCriterion(GsaDatumCriterion): def __init__( self, *, - type: "GsaDatumCriterionType" = GsaDatumCriterionType.SMARTLINKINGVALUE, + type: "GsaDatumCriterionType" = GsaDatumCriterionType.DYNAMICLINKINGVALUE, attribute_type: "GsaAttributeType | Unset_Type" = Unset, inner_hits_identifier: "str | Unset_Type" = Unset, ) -> None: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_links_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_links_info.py index fde7bf1e9..760617df4 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_links_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_links_info.py @@ -61,7 +61,7 @@ class GsaLinksInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "links": "list[GsaLink]", + "links": "list[GsaResolvedLink]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaLinksInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "links": "GsaLink", + "links": "GsaResolvedLink", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaLinksInfo(ModelBase): def __init__( self, *, - links: "list[GsaLink]", + links: "list[GsaResolvedLink]", ) -> None: """GsaLinksInfo - a model defined in Swagger Parameters ---------- - links: list[GsaLink] + links: list[GsaResolvedLink] """ - self._links: list[GsaLink] + self._links: list[GsaResolvedLink] self.links = links @property - def links(self) -> "list[GsaLink]": + def links(self) -> "list[GsaResolvedLink]": """Gets the links of this GsaLinksInfo. Returns ------- - list[GsaLink] + list[GsaResolvedLink] The links of this GsaLinksInfo. """ return self._links @links.setter - def links(self, links: "list[GsaLink]") -> None: + def links(self, links: "list[GsaResolvedLink]") -> None: """Sets the links of this GsaLinksInfo. Parameters ---------- - links: list[GsaLink] + links: list[GsaResolvedLink] The links of this GsaLinksInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_date_time_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_date_time_tabular_column.py index 73a74736a..37d8f0b85 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_date_time_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_date_time_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalDateTimeTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalDateTimeTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalDateTimeTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_discrete_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_discrete_tabular_column.py index 3c7623ddf..2bbb94b54 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_discrete_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_discrete_tabular_column.py @@ -74,13 +74,11 @@ class GsaLocalDiscreteTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -90,13 +88,11 @@ class GsaLocalDiscreteTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -115,13 +111,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalDiscreteTabularColumn - a model defined in Swagger @@ -133,26 +127,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._discrete_type: GsaSlimNamedEntity diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_file_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_file_tabular_column.py index 32495e575..13f7e8d15 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_file_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_file_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalFileTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalFileTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalFileTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_hyperlink_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_hyperlink_tabular_column.py index 07fc7cf92..13da88f6b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_hyperlink_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_hyperlink_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalHyperlinkTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalHyperlinkTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalHyperlinkTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_integer_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_integer_tabular_column.py index 4d55c606b..4bab9d561 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_integer_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_integer_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalIntegerTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalIntegerTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalIntegerTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_logical_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_logical_tabular_column.py index 772828e86..933ab4c91 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_logical_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_logical_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalLogicalTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalLogicalTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalLogicalTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_long_text_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_long_text_tabular_column.py index c650345af..a2f2c0f61 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_long_text_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_long_text_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalLongTextTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalLongTextTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalLongTextTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_picture_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_picture_tabular_column.py index be03827d3..ade63395a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_picture_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_picture_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalPictureTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalPictureTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalPictureTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_point_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_point_tabular_column.py index 8f388bad3..025c802ce 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_point_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_point_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalPointTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "unit": "GsaSlimUnit", } @@ -89,13 +87,11 @@ class GsaLocalPointTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "unit": "unit", } @@ -114,13 +110,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaLocalPointTabularColumn - a model defined in Swagger @@ -132,13 +126,11 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] unit: GsaSlimUnit, optional """ super().__init__( @@ -146,13 +138,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_range_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_range_tabular_column.py index 8a802ad20..e51ffdf6a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_range_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_range_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalRangeTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", "unit": "GsaSlimUnit", } @@ -89,13 +87,11 @@ class GsaLocalRangeTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", "unit": "unit", } @@ -114,13 +110,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaLocalRangeTabularColumn - a model defined in Swagger @@ -132,13 +126,11 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] unit: GsaSlimUnit, optional """ super().__init__( @@ -146,13 +138,11 @@ def __init__( display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_short_text_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_short_text_tabular_column.py index fb5823906..19b5d3d71 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_short_text_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_local_short_text_tabular_column.py @@ -73,13 +73,11 @@ class GsaLocalShortTextTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -88,13 +86,11 @@ class GsaLocalShortTextTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -111,13 +107,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaLocalShortTextTabularColumn - a model defined in Swagger @@ -128,26 +122,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) self._default_threshold_type: GsaAttributeThresholdType diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_log_scale_negative_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_log_scale_negative_parameter_value_error_detail.py deleted file mode 100644 index aacbf0c4a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_log_scale_negative_parameter_value_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLogScaleNegativeParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.LOGSCALENEGATIVE, - ) -> None: - """GsaLogScaleNegativeParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLogScaleNegativeParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_attribute.py index 3f7bb41f5..e90816e95 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_attribute.py @@ -69,7 +69,6 @@ class GsaLogicalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaLogicalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.LOGICAL, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_chart_data.py deleted file mode 100644 index a439e693b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_logical_chart_data.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaLogicalChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "record_version_guid": "str", - "value": "bool", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.LOGICAL, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "bool | Unset_Type" = Unset, - ) -> None: - """GsaLogicalChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - record_version_guid: str, optional - value: bool, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: bool | Unset_Type = Unset - - if value is not Unset: - self.value = value - - @property - def value(self) -> "bool | Unset_Type": - """Gets the value of this GsaLogicalChartData. - - Returns - ------- - bool | Unset_Type - The value of this GsaLogicalChartData. - """ - return self._value - - @value.setter - def value(self, value: "bool | Unset_Type") -> None: - """Sets the value of this GsaLogicalChartData. - - Parameters - ---------- - value: bool | Unset_Type - The value of this GsaLogicalChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaLogicalChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_long_text_attribute.py index 8d47b605a..b11849bed 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_long_text_attribute.py @@ -69,7 +69,6 @@ class GsaLongTextAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaLongTextAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.LONGTEXT, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py deleted file mode 100644 index 702bc3948..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_many_to_many_forbid_orphans_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.MANYTOMANYFORBIDORPHANS, - ) -> None: - """GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_match_mode.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_match_mode.py deleted file mode 100644 index 1a0fe0275..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_match_mode.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaMatchMode(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - BASICGUIDMATCH = "BasicGuidMatch" - MATCHONGUIDTHENNAME = "MatchOnGuidThenName" - FULLGUIDSYNC = "FullGuidSync" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_maths_functional_attribute.py index 7bcf39f21..2c3c20684 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_maths_functional_attribute.py @@ -75,7 +75,6 @@ class GsaMathsFunctionalAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_range": "bool", "name": "str", "table": "GsaSlimEntity", @@ -98,7 +97,6 @@ class GsaMathsFunctionalAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_range": "isRange", "name": "name", "table": "table", @@ -132,7 +130,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_range: "bool", name: "str", table: "GsaSlimEntity", @@ -157,7 +154,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_range: bool name: str table: GsaSlimEntity @@ -173,7 +169,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_max_permissions_reached_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_max_permissions_reached_permission_error_detail.py deleted file mode 100644 index 913ece3df..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_max_permissions_reached_permission_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMaxPermissionsReachedPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.MAXPERMISSIONSREACHED, - ) -> None: - """GsaMaxPermissionsReachedPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - self._max_number_of_permissions: int - - self.max_number_of_permissions = max_number_of_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaMaxPermissionsReachedPermissionErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMaxPermissionsReachedPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py deleted file mode 100644 index 866aaffbf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_meta_attribute_cannot_have_meta_attribute_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_attribute_error_detail import ( # noqa: F401 - GsaAttributeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_attribute_error_reason import ( - GsaAttributeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMetaAttributeCannotHaveMetaAttributeErrorDetail(GsaAttributeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAttributeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAttributeErrorReason" = GsaAttributeErrorReason.METAATTRIBUTECANNOTHAVEMETAATTRIBUTE, - ) -> None: - """GsaMetaAttributeCannotHaveMetaAttributeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAttributeErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMetaAttributeCannotHaveMetaAttributeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py deleted file mode 100644 index 51c0dbff0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multi_valued_point_data_usage_data_modification_error_detail.py +++ /dev/null @@ -1,135 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultiValuedPointDataUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.MULTIVALUEDPOINTDATA, - ) -> None: - """GsaMultiValuedPointDataUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultiValuedPointDataUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py deleted file mode 100644 index 1bf7b4e6e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_multiple_table_discrete_values_in_single_valued_discrete_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail( - GsaAccessControlCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - "attribute_guid": "str", - "table_discrete_value_count": "int", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "attribute_guid": "attributeGuid", - "table_discrete_value_count": "tableDiscreteValueCount", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.MULTIPLEDEFAULTVALUESINSINGLEVALUEDDISCRETE, - attribute_guid: "str | Unset_Type" = Unset, - table_discrete_value_count: "int | Unset_Type" = Unset, - ) -> None: - """GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaAccessControlCategoryErrorReason - attribute_guid: str, optional - table_discrete_value_count: int, optional - """ - super().__init__(message=message, reason=reason) - self._attribute_guid: str | Unset_Type = Unset - self._table_discrete_value_count: int | Unset_Type = Unset - - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if table_discrete_value_count is not Unset: - self.table_discrete_value_count = table_discrete_value_count - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def table_discrete_value_count(self) -> "int | Unset_Type": - """Gets the table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Returns - ------- - int | Unset_Type - The table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - return self._table_discrete_value_count - - @table_discrete_value_count.setter - def table_discrete_value_count(self, table_discrete_value_count: "int | Unset_Type") -> None: - """Sets the table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - - Parameters - ---------- - table_discrete_value_count: int | Unset_Type - The table_discrete_value_count of this GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail. - """ - # Field is not nullable - if table_discrete_value_count is None: - raise ValueError("Invalid value for 'table_discrete_value_count', must not be 'None'") - self._table_discrete_value_count = table_discrete_value_count - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py deleted file mode 100644 index 4bb94b6a8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_as_reverse_record_link_group_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "name": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "name": "name", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - name: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMEALREADYEXISTSASREVERSE, - ) -> None: - """GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - name: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._name: str - - self.name = name - - @property - def name(self) -> "str": - """Gets the name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - - Returns - ------- - str - The name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - - Parameters - ---------- - name: str - The name of this GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_error_detail.py index e49ab92b9..242d46a04 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_exists_error_detail.py @@ -68,54 +68,45 @@ class GsaNameAlreadyExistsErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", "name": "str", - "parent_entity_type": "GsaEntityType", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", "name": "name", - "parent_entity_type": "parentEntityType", } - subtype_mapping: dict[str, str] = { - "parentEntityType": "GsaEntityType", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMEALREADYEXISTS, + entity_type_name: "str | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - parent_entity_type: "GsaEntityType | Unset_Type" = Unset, ) -> None: """GsaNameAlreadyExistsErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional name: str | None, optional - parent_entity_type: GsaEntityType, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) self._name: str | None | Unset_Type = Unset - self._parent_entity_type: GsaEntityType | Unset_Type = Unset if name is not Unset: self.name = name - if parent_entity_type is not Unset: - self.parent_entity_type = parent_entity_type @property def name(self) -> "str | None | Unset_Type": @@ -139,31 +130,6 @@ def name(self, name: "str | None | Unset_Type") -> None: """ self._name = name - @property - def parent_entity_type(self) -> "GsaEntityType | Unset_Type": - """Gets the parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - - Returns - ------- - GsaEntityType | Unset_Type - The parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - """ - return self._parent_entity_type - - @parent_entity_type.setter - def parent_entity_type(self, parent_entity_type: "GsaEntityType | Unset_Type") -> None: - """Sets the parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - - Parameters - ---------- - parent_entity_type: GsaEntityType | Unset_Type - The parent_entity_type of this GsaNameAlreadyExistsErrorDetail. - """ - # Field is not nullable - if parent_entity_type is None: - raise ValueError("Invalid value for 'parent_entity_type', must not be 'None'") - self._parent_entity_type = parent_entity_type - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_specified_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_specified_error_detail.py deleted file mode 100644 index f08826218..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_already_specified_error_detail.py +++ /dev/null @@ -1,162 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_detail import ( # noqa: F401 - GsaNamedEntityErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_named_entity_error_reason import ( - GsaNamedEntityErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameAlreadySpecifiedErrorDetail(GsaNamedEntityErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", - "message": "str", - "reason": "GsaNamedEntityErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaEntityType", - message: "str", - reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMEALREADYSPECIFIED, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameAlreadySpecifiedErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaEntityType - message: str - reason: GsaNamedEntityErrorReason - name: str | None, optional - """ - super().__init__(entity_type=entity_type, message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameAlreadySpecifiedErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameAlreadySpecifiedErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameAlreadySpecifiedErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameAlreadySpecifiedErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameAlreadySpecifiedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_missing_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_missing_currency_error_detail.py deleted file mode 100644 index c2ec01895..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_missing_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameMissingCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.NAMEMISSING, - ) -> None: - """GsaNameMissingCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameMissingCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_not_provided_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_not_provided_error_detail.py index bf3fcb9b8..6f9cee47c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_not_provided_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_not_provided_error_detail.py @@ -68,15 +68,15 @@ class GsaNameNotProvidedErrorDetail(GsaNamedEntityErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", } subtype_mapping: dict[str, str] = {} @@ -86,19 +86,19 @@ class GsaNameNotProvidedErrorDetail(GsaNamedEntityErrorDetail): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason" = GsaNamedEntityErrorReason.NAMENOTPROVIDED, + entity_type_name: "str | None | Unset_Type" = Unset, ) -> None: """GsaNameNotProvidedErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional """ - super().__init__(entity_type=entity_type, message=message, reason=reason) + super().__init__(message=message, reason=reason, entity_type_name=entity_type_name) @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py deleted file mode 100644 index e4f739e86..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_same_as_reverse_name_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameSameAsReverseNameRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMESAMEASREVERSENAME, - ) -> None: - """GsaNameSameAsReverseNameRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameSameAsReverseNameRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_currency_error_detail.py deleted file mode 100644 index 3ba5be5b3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_currency_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameWhitespaceCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.NAMEWHITESPACE, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameWhitespaceCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameWhitespaceCurrencyErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameWhitespaceCurrencyErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameWhitespaceCurrencyErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameWhitespaceCurrencyErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameWhitespaceCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_parameter_value_error_detail.py deleted file mode 100644 index bbffdbe5d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_name_whitespace_parameter_value_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNameWhitespaceParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.NAMEWHITESPACE, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaNameWhitespaceParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaNameWhitespaceParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaNameWhitespaceParameterValueErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaNameWhitespaceParameterValueErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaNameWhitespaceParameterValueErrorDetail. - """ - self._name = name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNameWhitespaceParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_access_control_category_error_detail.py deleted file mode 100644 index f39061d3a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_access_control_category_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityAccessControlCategoryErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_constant_error_detail.py deleted file mode 100644 index 8e04f44f4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_constant_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_constant_error_detail import ( # noqa: F401 - GsaConstantErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_constant_error_reason import ( - GsaConstantErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityConstantErrorDetail(GsaConstantErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason" = GsaConstantErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityConstantErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityConstantErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityConstantErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityConstantErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_detail.py index ed6ffbabe..9dea03c9f 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_detail.py @@ -63,31 +63,26 @@ class GsaNamedEntityErrorDetail(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "entity_type": "GsaEntityType", "message": "str", "reason": "GsaNamedEntityErrorReason", + "entity_type_name": "str", } attribute_map: dict[str, str] = { - "entity_type": "entityType", "message": "message", "reason": "reason", + "entity_type_name": "entityTypeName", } subtype_mapping: dict[str, str] = { "reason": "GsaNamedEntityErrorReason", - "entityType": "GsaEntityType", } discriminator_value_class_map = { "entityAlreadyExists".lower(): "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", "nameNotProvided".lower(): "#/components/schemas/GsaNameNotProvidedErrorDetail", "nameAlreadyExists".lower(): "#/components/schemas/GsaNameAlreadyExistsErrorDetail", - "nameAlreadySpecified".lower(): "#/components/schemas/GsaNameAlreadySpecifiedErrorDetail", "entityIdentifierAlreadySpecified".lower(): "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "displayNameEmpty".lower(): "#/components/schemas/GsaDisplayNameEmptyErrorDetail", - "displayNameLanguageNotProvided".lower(): "#/components/schemas/GsaDisplayNameLanguageNotProvidedErrorDetail", - "displayNameLanguageNotSupported".lower(): "#/components/schemas/GsaDisplayNameLanguageNotSupportedErrorDetail", } discriminator: Optional[str] = "reason" @@ -95,25 +90,26 @@ class GsaNamedEntityErrorDetail(ModelBase): def __init__( self, *, - entity_type: "GsaEntityType", message: "str", reason: "GsaNamedEntityErrorReason", + entity_type_name: "str | None | Unset_Type" = Unset, ) -> None: """GsaNamedEntityErrorDetail - a model defined in Swagger Parameters ---------- - entity_type: GsaEntityType message: str reason: GsaNamedEntityErrorReason + entity_type_name: str | None, optional """ self._message: str self._reason: GsaNamedEntityErrorReason - self._entity_type: GsaEntityType + self._entity_type_name: str | None | Unset_Type = Unset self.message = message self.reason = reason - self.entity_type = entity_type + if entity_type_name is not Unset: + self.entity_type_name = entity_type_name @property def message(self) -> "str": @@ -172,32 +168,28 @@ def reason(self, reason: "GsaNamedEntityErrorReason") -> None: self._reason = reason @property - def entity_type(self) -> "GsaEntityType": - """Gets the entity_type of this GsaNamedEntityErrorDetail. + def entity_type_name(self) -> "str | None | Unset_Type": + """Gets the entity_type_name of this GsaNamedEntityErrorDetail. + e.g. 'Attribute', 'Meta-attribute' Returns ------- - GsaEntityType - The entity_type of this GsaNamedEntityErrorDetail. + str | None | Unset_Type + The entity_type_name of this GsaNamedEntityErrorDetail. """ - return self._entity_type + return self._entity_type_name - @entity_type.setter - def entity_type(self, entity_type: "GsaEntityType") -> None: - """Sets the entity_type of this GsaNamedEntityErrorDetail. + @entity_type_name.setter + def entity_type_name(self, entity_type_name: "str | None | Unset_Type") -> None: + """Sets the entity_type_name of this GsaNamedEntityErrorDetail. + e.g. 'Attribute', 'Meta-attribute' Parameters ---------- - entity_type: GsaEntityType - The entity_type of this GsaNamedEntityErrorDetail. + entity_type_name: str | None | Unset_Type + The entity_type_name of this GsaNamedEntityErrorDetail. """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type + self._entity_type_name = entity_type_name @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_reason.py index b827d37e3..fce40b1de 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_reason.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_error_reason.py @@ -46,7 +46,3 @@ class GsaNamedEntityErrorReason(Enum): ENTITYIDENTIFIERALREADYSPECIFIED = "entityIdentifierAlreadySpecified" NAMENOTPROVIDED = "nameNotProvided" NAMEALREADYEXISTS = "nameAlreadyExists" - NAMEALREADYSPECIFIED = "nameAlreadySpecified" - DISPLAYNAMEEMPTY = "displayNameEmpty" - DISPLAYNAMELANGUAGENOTPROVIDED = "displayNameLanguageNotProvided" - DISPLAYNAMELANGUAGENOTSUPPORTED = "displayNameLanguageNotSupported" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_file_error_detail.py deleted file mode 100644 index f1f0ecfdf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_file_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityFileErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFileErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityFileErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFileErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_folder_error_detail.py deleted file mode 100644 index 57a0ac2fa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_folder_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityFolderErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFolderErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityFolderErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityFolderErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_error_detail.py deleted file mode 100644 index 6826cf15f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityParameterErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityParameterErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_value_error_detail.py deleted file mode 100644 index a4d344c24..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_parameter_value_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityParameterValueErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterValueErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityParameterValueErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityParameterValueErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_permission_error_detail.py deleted file mode 100644 index 8de8bd478..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_permission_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityPermissionErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityPermissionErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityPermissionErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_record_link_group_error_detail.py deleted file mode 100644 index 29a6c0339..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_record_link_group_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_table_error_detail.py deleted file mode 100644 index ecaaac976..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_table_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityTableErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaNamedEntityErrorDetail]", - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaNamedEntityErrorDetail]", - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.NAMEDENTITY, - ) -> None: - """GsaNamedEntityTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail]": - """Gets the errors of this GsaNamedEntityTableErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityTableErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail]") -> None: - """Sets the errors of this GsaNamedEntityTableErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] - The errors of this GsaNamedEntityTableErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_unit_error_detail.py deleted file mode 100644 index ea8375a41..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_named_entity_unit_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNamedEntityUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "errors": "list[GsaNamedEntityErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaNamedEntityErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.NAMEDENTITY, - errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaNamedEntityUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - errors: list[GsaNamedEntityErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaNamedEntityErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaNamedEntityUnitErrorDetail. - - Returns - ------- - list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityUnitErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaNamedEntityErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaNamedEntityUnitErrorDetail. - - Parameters - ---------- - errors: list[GsaNamedEntityErrorDetail] | None | Unset_Type - The errors of this GsaNamedEntityUnitErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNamedEntityUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py deleted file mode 100644 index 5eef23c61..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_attribute_pairs_smart_attributes_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoAttributePairsSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.NOATTRIBUTEPAIRS, - ) -> None: - """GsaNoAttributePairsSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoAttributePairsSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_data_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_data_file_error_detail.py deleted file mode 100644 index f4218c615..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_data_file_error_detail.py +++ /dev/null @@ -1,159 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoDataFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - "is_configuration": "bool", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "is_configuration": "isConfiguration", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NODATA, - is_configuration: "bool | Unset_Type" = Unset, - ) -> None: - """GsaNoDataFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - is_configuration: bool, optional - """ - super().__init__(message=message, reason=reason) - self._is_configuration: bool | Unset_Type = Unset - - if is_configuration is not Unset: - self.is_configuration = is_configuration - - @property - def is_configuration(self) -> "bool | Unset_Type": - """Gets the is_configuration of this GsaNoDataFileErrorDetail. - - Returns - ------- - bool | Unset_Type - The is_configuration of this GsaNoDataFileErrorDetail. - """ - return self._is_configuration - - @is_configuration.setter - def is_configuration(self, is_configuration: "bool | Unset_Type") -> None: - """Sets the is_configuration of this GsaNoDataFileErrorDetail. - - Parameters - ---------- - is_configuration: bool | Unset_Type - The is_configuration of this GsaNoDataFileErrorDetail. - """ - # Field is not nullable - if is_configuration is None: - raise ValueError("Invalid value for 'is_configuration', must not be 'None'") - self._is_configuration = is_configuration - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoDataFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_file_file_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_file_file_error_detail.py deleted file mode 100644 index 7c2d1c0e1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_file_file_error_detail.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_detail import ( # noqa: F401 - GsaFileErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_error_reason import GsaFileErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoFileFileErrorDetail(GsaFileErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileErrorReason" = GsaFileErrorReason.NOFILE, - ) -> None: - """GsaNoFileFileErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoFileFileErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_parameter_values_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_parameter_values_parameter_error_detail.py deleted file mode 100644 index 790d3c597..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_parameter_values_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoParameterValuesParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NOPARAMETERVALUES, - ) -> None: - """GsaNoParameterValuesParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoParameterValuesParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_permissions_permission_category_error_detail.py deleted file mode 100644 index b5bacbfa1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.NOPERMISSIONS, - ) -> None: - """GsaNoPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_attribute_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_attribute_smart_attributes_error_detail.py deleted file mode 100644 index 6a89b80dc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_attribute_smart_attributes_error_detail.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchAttributeSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guid": "str", - "database_key": "str", - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "attribute_guid": "attributeGuid", - "database_key": "databaseKey", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guid: "str", - database_key: "str", - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.NOSUCHATTRIBUTE, - table_guid: "str", - ) -> None: - """GsaNoSuchAttributeSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - attribute_guid: str - database_key: str - message: str - reason: GsaSmartAttributesErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._database_key: str - self._table_guid: str - self._attribute_guid: str - - self.database_key = database_key - self.table_guid = table_guid - self.attribute_guid = attribute_guid - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - database_key: str - The database_key of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def attribute_guid(self) -> "str": - """Gets the attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Returns - ------- - str - The attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str") -> None: - """Sets the attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - - Parameters - ---------- - attribute_guid: str - The attribute_guid of this GsaNoSuchAttributeSmartAttributesErrorDetail. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - # Field is required - if attribute_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_guid', must not be 'Unset'") - self._attribute_guid = attribute_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchAttributeSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_categories_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_categories_replace_permission_category_error_detail.py deleted file mode 100644 index 114926151..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_categories_replace_permission_category_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.NOSUCHCATEGORIES, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReplacePermissionCategoryErrorReason - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_guids: list[str] | None | Unset_Type = Unset - - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_category_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_category_access_control_error_detail.py deleted file mode 100644 index 961d6bcb2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_category_access_control_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchCategoryAccessControlErrorDetail(GsaPermissionCategoriesAccessControlErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.NOSUCHCATEGORY, - ) -> None: - """GsaNoSuchCategoryAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._category_guid: str - - self.category_guid = category_guid - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaNoSuchCategoryAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchCategoryAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_entity_access_control_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_entity_access_control_category_error_detail.py deleted file mode 100644 index 6e6b32469..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_entity_access_control_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_detail import ( # noqa: F401 - GsaAccessControlCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_category_error_reason import ( - GsaAccessControlCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchEntityAccessControlCategoryErrorDetail(GsaAccessControlCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entity_type": "GsaAccessControlCategoryNoSuchEntityType", - "guid": "str", - "message": "str", - "reason": "GsaAccessControlCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "entity_type": "entityType", - "guid": "guid", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "entityType": "GsaAccessControlCategoryNoSuchEntityType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entity_type: "GsaAccessControlCategoryNoSuchEntityType", - guid: "str", - message: "str", - reason: "GsaAccessControlCategoryErrorReason" = GsaAccessControlCategoryErrorReason.NOSUCHENTITY, - ) -> None: - """GsaNoSuchEntityAccessControlCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - entity_type: GsaAccessControlCategoryNoSuchEntityType - guid: str - message: str - reason: GsaAccessControlCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._guid: str - self._entity_type: GsaAccessControlCategoryNoSuchEntityType - - self.guid = guid - self.entity_type = entity_type - - @property - def guid(self) -> "str": - """Gets the guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Returns - ------- - str - The guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - guid: str - The guid of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def entity_type(self) -> "GsaAccessControlCategoryNoSuchEntityType": - """Gets the entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Returns - ------- - GsaAccessControlCategoryNoSuchEntityType - The entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - return self._entity_type - - @entity_type.setter - def entity_type(self, entity_type: "GsaAccessControlCategoryNoSuchEntityType") -> None: - """Sets the entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - - Parameters - ---------- - entity_type: GsaAccessControlCategoryNoSuchEntityType - The entity_type of this GsaNoSuchEntityAccessControlCategoryErrorDetail. - """ - # Field is not nullable - if entity_type is None: - raise ValueError("Invalid value for 'entity_type', must not be 'None'") - # Field is required - if entity_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entity_type', must not be 'Unset'") - self._entity_type = entity_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchEntityAccessControlCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_file_move_error_detail.py deleted file mode 100644 index c4cf176fa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_file_move_error_detail.py +++ /dev/null @@ -1,224 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchNewParentFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "database_key": "str", - "folder_guid": "str", - "folder_type": "GsaFolderType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "database_key": "databaseKey", - "folder_guid": "folderGuid", - "folder_type": "folderType", - } - - subtype_mapping: dict[str, str] = { - "folderType": "GsaFolderType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.NOSUCHNEWPARENT, - database_key: "str | None | Unset_Type" = Unset, - folder_guid: "str | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchNewParentFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - database_key: str | None, optional - folder_guid: str, optional - folder_type: GsaFolderType, optional - """ - super().__init__(message=message, reason=reason) - self._folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._database_key: str | None | Unset_Type = Unset - - if folder_guid is not Unset: - self.folder_guid = folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if database_key is not Unset: - self.database_key = database_key - - @property - def folder_guid(self) -> "str | Unset_Type": - """Gets the folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._folder_guid - - @folder_guid.setter - def folder_guid(self, folder_guid: "str | Unset_Type") -> None: - """Sets the folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - folder_guid: str | Unset_Type - The folder_guid of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - # Field is not nullable - if folder_guid is None: - raise ValueError("Invalid value for 'folder_guid', must not be 'None'") - self._folder_guid = folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFileMoveErrorDetail. - """ - self._database_key = database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchNewParentFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_folder_move_error_detail.py deleted file mode 100644 index b9c7cb4e8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_new_parent_folder_move_error_detail.py +++ /dev/null @@ -1,224 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchNewParentFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - "database_key": "str", - "folder_type": "GsaFolderType", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "database_key": "databaseKey", - "folder_type": "folderType", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = { - "folderType": "GsaFolderType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.NOSUCHNEWPARENT, - database_key: "str | None | Unset_Type" = Unset, - folder_type: "GsaFolderType | Unset_Type" = Unset, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchNewParentFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - database_key: str | None, optional - folder_type: GsaFolderType, optional - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - self._folder_type: GsaFolderType | Unset_Type = Unset - self._database_key: str | None | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - if folder_type is not Unset: - self.folder_type = folder_type - if database_key is not Unset: - self.database_key = database_key - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @property - def folder_type(self) -> "GsaFolderType | Unset_Type": - """Gets the folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._folder_type - - @folder_type.setter - def folder_type(self, folder_type: "GsaFolderType | Unset_Type") -> None: - """Sets the folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - folder_type: GsaFolderType | Unset_Type - The folder_type of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - # Field is not nullable - if folder_type is None: - raise ValueError("Invalid value for 'folder_type', must not be 'None'") - self._folder_type = folder_type - - @property - def database_key(self) -> "str | None | Unset_Type": - """Gets the database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Returns - ------- - str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str | None | Unset_Type") -> None: - """Sets the database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - - Parameters - ---------- - database_key: str | None | Unset_Type - The database_key of this GsaNoSuchNewParentFolderMoveErrorDetail. - """ - self._database_key = database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchNewParentFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permission_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permission_access_control_error_detail.py deleted file mode 100644 index 8c2bddae5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permission_access_control_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_detail import ( # noqa: F401 - GsaPermissionCategoriesAccessControlErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_categories_access_control_error_reason import ( - GsaPermissionCategoriesAccessControlErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchPermissionAccessControlErrorDetail(GsaPermissionCategoriesAccessControlErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_guid": "str", - "message": "str", - "permission_guid": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "category_guid": "categoryGuid", - "message": "message", - "permission_guid": "permissionGuid", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_guid: "str", - message: "str", - permission_guid: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason" = GsaPermissionCategoriesAccessControlErrorReason.NOSUCHPERMISSION, - ) -> None: - """GsaNoSuchPermissionAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - category_guid: str - message: str - permission_guid: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - super().__init__(message=message, reason=reason) - self._permission_guid: str - self._category_guid: str - - self.permission_guid = permission_guid - self.category_guid = category_guid - - @property - def permission_guid(self) -> "str": - """Gets the permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Returns - ------- - str - The permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - return self._permission_guid - - @permission_guid.setter - def permission_guid(self, permission_guid: "str") -> None: - """Sets the permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Parameters - ---------- - permission_guid: str - The permission_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - # Field is not nullable - if permission_guid is None: - raise ValueError("Invalid value for 'permission_guid', must not be 'None'") - # Field is required - if permission_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_guid', must not be 'Unset'") - self._permission_guid = permission_guid - - @property - def category_guid(self) -> "str": - """Gets the category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Returns - ------- - str - The category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - return self._category_guid - - @category_guid.setter - def category_guid(self, category_guid: "str") -> None: - """Sets the category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - - Parameters - ---------- - category_guid: str - The category_guid of this GsaNoSuchPermissionAccessControlErrorDetail. - """ - # Field is not nullable - if category_guid is None: - raise ValueError("Invalid value for 'category_guid', must not be 'None'") - # Field is required - if category_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_guid', must not be 'Unset'") - self._category_guid = category_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchPermissionAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permissions_permission_category_error_detail.py deleted file mode 100644 index 19e70ddbf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - "missing_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "missing_guids": "missingGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.NOSUCHPERMISSIONS, - missing_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - missing_guids: list[str] | None, optional - """ - super().__init__(message=message, reason=reason) - self._missing_guids: list[str] | None | Unset_Type = Unset - - if missing_guids is not Unset: - self.missing_guids = missing_guids - - @property - def missing_guids(self) -> "list[str] | None | Unset_Type": - """Gets the missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - """ - return self._missing_guids - - @missing_guids.setter - def missing_guids(self, missing_guids: "list[str] | None | Unset_Type") -> None: - """Sets the missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - missing_guids: list[str] | None | Unset_Type - The missing_guids of this GsaNoSuchPermissionsPermissionCategoryErrorDetail. - """ - self._missing_guids = missing_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_target_table_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_target_table_record_link_group_error_detail.py deleted file mode 100644 index 94c36bc09..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_target_table_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchTargetTableRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "table_guid": "str", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "message": "message", - "reason": "reason", - "table_guid": "tableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.NOSUCHTARGETTABLE, - table_guid: "str", - ) -> None: - """GsaNoSuchTargetTableRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - database_key: str - message: str - reason: GsaRecordLinkGroupErrorReason - table_guid: str - """ - super().__init__(message=message, reason=reason) - self._database_key: str - self._table_guid: str - - self.database_key = database_key - self.table_guid = table_guid - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Returns - ------- - str - The database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Parameters - ---------- - database_key: str - The database_key of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Returns - ------- - str - The table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaNoSuchTargetTableRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchTargetTableRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_constant_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_constant_error_detail.py deleted file mode 100644 index d8f4a8202..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_constant_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_constant_error_detail import ( # noqa: F401 - GsaConstantErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_constant_error_reason import ( - GsaConstantErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitConstantErrorDetail(GsaConstantErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaConstantErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaConstantErrorReason" = GsaConstantErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitConstantErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaConstantErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitConstantErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitConstantErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitConstantErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitConstantErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitConstantErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_parameter_error_detail.py deleted file mode 100644 index 1646e81d2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_parameter_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitParameterErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitParameterErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitParameterErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitParameterErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py deleted file mode 100644 index 9ff0a73f1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_system_unit_equivalent_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitSystemUnitEquivalentErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.NOSUCHUNITSYSTEM, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitSystemUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitSystemUnitEquivalentErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitSystemUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_unit_equivalent_error_detail.py deleted file mode 100644 index 4086f1eba..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_no_such_unit_unit_equivalent_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_detail import ( # noqa: F401 - GsaUnitEquivalentErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equivalent_error_reason import ( - GsaUnitEquivalentErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNoSuchUnitUnitEquivalentErrorDetail(GsaUnitEquivalentErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - "guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason" = GsaUnitEquivalentErrorReason.NOSUCHUNIT, - guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaNoSuchUnitUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._guid: str | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - - Returns - ------- - str | Unset_Type - The guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaNoSuchUnitUnitEquivalentErrorDetail. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNoSuchUnitUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py deleted file mode 100644 index 53e252a11..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_non_custom_standard_name_cannot_be_changed_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNonCustomStandardNameCannotBeChangedErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "standard_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "standard_name": "standardName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.NONCUSTOMSTANDARDNAMECANNOTBECHANGED, - standard_name: "str", - ) -> None: - """GsaNonCustomStandardNameCannotBeChangedErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - standard_name: str - """ - super().__init__(message=message, reason=reason) - self._standard_name: str - - self.standard_name = standard_name - - @property - def standard_name(self) -> "str": - """Gets the standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - - Returns - ------- - str - The standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - """ - return self._standard_name - - @standard_name.setter - def standard_name(self, standard_name: "str") -> None: - """Sets the standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - - Parameters - ---------- - standard_name: str - The standard_name of this GsaNonCustomStandardNameCannotBeChangedErrorDetail. - """ - # Field is not nullable - if standard_name is None: - raise ValueError("Invalid value for 'standard_name', must not be 'None'") - # Field is required - if standard_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'standard_name', must not be 'Unset'") - self._standard_name = standard_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNonCustomStandardNameCannotBeChangedErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_number_parsing_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_number_parsing_unit_equation_error_detail.py deleted file mode 100644 index 0575fcb59..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_number_parsing_unit_equation_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNumberParsingUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "invalid_number": "str", - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "invalid_number": "invalidNumber", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - invalid_number: "str", - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.NUMBERPARSING, - ) -> None: - """GsaNumberParsingUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - invalid_number: str - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - self._invalid_number: str - - self.invalid_number = invalid_number - - @property - def invalid_number(self) -> "str": - """Gets the invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - - Returns - ------- - str - The invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - """ - return self._invalid_number - - @invalid_number.setter - def invalid_number(self, invalid_number: "str") -> None: - """Sets the invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - - Parameters - ---------- - invalid_number: str - The invalid_number of this GsaNumberParsingUnitEquationErrorDetail. - """ - # Field is not nullable - if invalid_number is None: - raise ValueError("Invalid value for 'invalid_number', must not be 'None'") - # Field is required - if invalid_number is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'invalid_number', must not be 'Unset'") - self._invalid_number = invalid_number - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNumberParsingUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_parameter.py index 2509654fe..1995519dd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_parameter.py @@ -73,6 +73,7 @@ class GsaNumericParameter(GsaParameter): "scale_type": "GsaParameterScaleType", "type": "GsaParameterType", "values": "list[GsaNumericParameterValue]", + "help_path": "str", "unit": "GsaSlimUnit", } @@ -86,6 +87,7 @@ class GsaNumericParameter(GsaParameter): "scale_type": "scaleType", "type": "type", "values": "values", + "help_path": "helpPath", "unit": "unit", } @@ -110,6 +112,7 @@ def __init__( scale_type: "GsaParameterScaleType", type: "GsaParameterType" = GsaParameterType.NUMERIC, values: "list[GsaNumericParameterValue]", + help_path: "str | None | Unset_Type" = Unset, unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: """GsaNumericParameter - a model defined in Swagger @@ -125,6 +128,7 @@ def __init__( scale_type: GsaParameterScaleType type: GsaParameterType values: list[GsaNumericParameterValue] + help_path: str | None, optional unit: GsaSlimUnit, optional """ super().__init__( @@ -133,6 +137,7 @@ def __init__( guid=guid, name=name, type=type, + help_path=help_path, ) self._is_restricted: bool self._unit: GsaSlimUnit | Unset_Type = Unset diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py deleted file mode 100644 index 223411f8c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_numeric_restricted_interpolation_parameter_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaNumericRestrictedInterpolationParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.NUMERICRESTRICTEDINTERPOLATION, - ) -> None: - """GsaNumericRestrictedInterpolationParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaNumericRestrictedInterpolationParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_item_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_item_type.py deleted file mode 100644 index a362c754d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_item_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPaginatedItemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - XYCHARTTEMPLATE = "xyChartTemplate" - ACTIVITYLOG = "activityLog" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_response_of.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_response_of.py deleted file mode 100644 index 16a9c65c1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_paginated_response_of.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPaginatedResponseOf(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaTItem]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaTItem", - "links": "GsaPaginationLinks", - } - - discriminator_value_class_map = { - "xyChartTemplate".lower(): "#/components/schemas/GsaXYChartTemplatesInfo", - "activityLog".lower(): "#/components/schemas/GsaActivityLogEntriesInfo", - } - - discriminator: Optional[str] = "itemType" - - def __init__( - self, - *, - entries: "list[GsaTItem]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaPaginatedResponseOf - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaTItem] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaTItem] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaPaginatedResponseOf. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaPaginatedResponseOf. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaPaginatedResponseOf. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaTItem]": - """Gets the entries of this GsaPaginatedResponseOf. - - Returns - ------- - list[GsaTItem] - The entries of this GsaPaginatedResponseOf. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaTItem]") -> None: - """Sets the entries of this GsaPaginatedResponseOf. - - Parameters - ---------- - entries: list[GsaTItem] - The entries of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaPaginatedResponseOf. - - Returns - ------- - GsaPaginationLinks - The links of this GsaPaginatedResponseOf. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaPaginatedResponseOf. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaPaginatedResponseOf. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPaginatedResponseOf): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_pagination_links.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_pagination_links.py deleted file mode 100644 index a2a506a43..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_pagination_links.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPaginationLinks(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "next": "str", - } - - attribute_map: dict[str, str] = { - "next": "next", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - next: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPaginationLinks - a model defined in Swagger - - Parameters - ---------- - next: str | None, optional - """ - self._next: str | None | Unset_Type = Unset - - if next is not Unset: - self.next = next - - @property - def next(self) -> "str | None | Unset_Type": - """Gets the next of this GsaPaginationLinks. - - Returns - ------- - str | None | Unset_Type - The next of this GsaPaginationLinks. - """ - return self._next - - @next.setter - def next(self, next: "str | None | Unset_Type") -> None: - """Sets the next of this GsaPaginationLinks. - - Parameters - ---------- - next: str | None | Unset_Type - The next of this GsaPaginationLinks. - """ - self._next = next - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPaginationLinks): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter.py index b168d71fd..9b683268b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter.py @@ -68,6 +68,7 @@ class GsaParameter(ModelBase): "guid": "str", "name": "str", "type": "GsaParameterType", + "help_path": "str", } attribute_map: dict[str, str] = { @@ -76,6 +77,7 @@ class GsaParameter(ModelBase): "guid": "guid", "name": "name", "type": "type", + "help_path": "helpPath", } subtype_mapping: dict[str, str] = { @@ -97,6 +99,7 @@ def __init__( guid: "str", name: "str", type: "GsaParameterType", + help_path: "str | None | Unset_Type" = Unset, ) -> None: """GsaParameter - a model defined in Swagger @@ -107,14 +110,18 @@ def __init__( guid: str name: str type: GsaParameterType + help_path: str | None, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_guid: str self._display_names: dict[str, str] self._name: str self._guid: str self.type = type + if help_path is not Unset: + self.help_path = help_path self.default_parameter_value_guid = default_parameter_value_guid self.display_names = display_names self.name = name @@ -148,6 +155,28 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaParameter. + """ + self._help_path = help_path + @property def default_parameter_value_guid(self) -> "str": """Gets the default_parameter_value_guid of this GsaParameter. @@ -181,7 +210,6 @@ def default_parameter_value_guid(self, default_parameter_value_guid: "str") -> N @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -193,7 +221,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_creation_exception.py deleted file mode 100644 index 16b518bc0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaParameterCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaParameterErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaParameterCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaParameterCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaParameterCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaParameterCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaParameterErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterCreationException. - - Returns - ------- - list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterCreationException. - - Parameters - ---------- - errors: list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_deletion_exception.py index b1273ddbc..9a0aa2b50 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_deletion_exception.py @@ -61,21 +61,19 @@ class GsaParameterDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaParameterDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaParameterDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaParameterDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaParameterDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaParameterDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaParameterDeletionException. - - Returns - ------- - str - The guid of this GsaParameterDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaParameterDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaParameterDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaParameterDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_detail.py deleted file mode 100644 index 0b0dccf2e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_detail.py +++ /dev/null @@ -1,203 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaParameterErrorReason", - } - - discriminator_value_class_map = { - "defaultParameterValueGuid".lower(): "#/components/schemas/GsaDefaultParameterValueGuidParameterErrorDetail", - "defaultParameterValueIndex".lower(): "#/components/schemas/GsaDefaultParameterValueIndexParameterErrorDetail", - "defaultParameterValueIndexWithoutValues".lower(): "#/components/schemas/GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", - "defaultParameterValueIndexAndGuid".lower(): "#/components/schemas/GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityParameterErrorDetail", - "noParameterValues".lower(): "#/components/schemas/GsaNoParameterValuesParameterErrorDetail", - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitParameterErrorDetail", - "numericRestrictedInterpolation".lower(): "#/components/schemas/GsaNumericRestrictedInterpolationParameterErrorDetail", - "parameterType".lower(): "#/components/schemas/GsaParameterTypeParameterErrorDetail", - "parameterValue".lower(): "#/components/schemas/GsaParameterValueParameterErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason", - ) -> None: - """GsaParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - """ - self._message: str - self._reason: GsaParameterErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaParameterErrorDetail. - - Returns - ------- - str - The message of this GsaParameterErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaParameterErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaParameterErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaParameterErrorReason": - """Gets the reason of this GsaParameterErrorDetail. - - Returns - ------- - GsaParameterErrorReason - The reason of this GsaParameterErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaParameterErrorReason") -> None: - """Sets the reason of this GsaParameterErrorDetail. - - Parameters - ---------- - reason: GsaParameterErrorReason - The reason of this GsaParameterErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_reason.py deleted file mode 100644 index 8133958b0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_error_reason.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DEFAULTPARAMETERVALUEGUID = "defaultParameterValueGuid" - DEFAULTPARAMETERVALUEINDEX = "defaultParameterValueIndex" - DEFAULTPARAMETERVALUEINDEXANDGUID = "defaultParameterValueIndexAndGuid" - DEFAULTPARAMETERVALUEINDEXWITHOUTVALUES = "defaultParameterValueIndexWithoutValues" - NAMEDENTITY = "namedEntity" - NOPARAMETERVALUES = "noParameterValues" - NOSUCHUNIT = "noSuchUnit" - NUMERICRESTRICTEDINTERPOLATION = "numericRestrictedInterpolation" - PARAMETERTYPE = "parameterType" - PARAMETERVALUE = "parameterValue" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_type_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_type_parameter_error_detail.py deleted file mode 100644 index 08c4220e9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_type_parameter_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterTypeParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "new_parameter_type": "GsaParameterType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parameter_type": "newParameterType", - } - - subtype_mapping: dict[str, str] = { - "newParameterType": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.PARAMETERTYPE, - new_parameter_type: "GsaParameterType | Unset_Type" = Unset, - ) -> None: - """GsaParameterTypeParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - new_parameter_type: GsaParameterType, optional - """ - super().__init__(message=message, reason=reason) - self._new_parameter_type: GsaParameterType | Unset_Type = Unset - - if new_parameter_type is not Unset: - self.new_parameter_type = new_parameter_type - - @property - def new_parameter_type(self) -> "GsaParameterType | Unset_Type": - """Gets the new_parameter_type of this GsaParameterTypeParameterErrorDetail. - - Returns - ------- - GsaParameterType | Unset_Type - The new_parameter_type of this GsaParameterTypeParameterErrorDetail. - """ - return self._new_parameter_type - - @new_parameter_type.setter - def new_parameter_type(self, new_parameter_type: "GsaParameterType | Unset_Type") -> None: - """Sets the new_parameter_type of this GsaParameterTypeParameterErrorDetail. - - Parameters - ---------- - new_parameter_type: GsaParameterType | Unset_Type - The new_parameter_type of this GsaParameterTypeParameterErrorDetail. - """ - # Field is not nullable - if new_parameter_type is None: - raise ValueError("Invalid value for 'new_parameter_type', must not be 'None'") - self._new_parameter_type = new_parameter_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterTypeParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_update_exception.py deleted file mode 100644 index 5ed18767c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_update_exception.py +++ /dev/null @@ -1,238 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterErrorDetail]", - "message": "str", - "parameter_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "parameter_guid": "parameterGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterErrorDetail] | None, optional - message: str | None, optional - parameter_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterUpdateException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterUpdateException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterUpdateException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterUpdateException. - - Returns - ------- - list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterUpdateException. - - Parameters - ---------- - errors: list[GsaParameterErrorDetail] | None | Unset_Type - The errors of this GsaParameterUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_usage_data_modification_error_detail.py deleted file mode 100644 index 1495077d6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.PARAMETER, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaParameterUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaParameterUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaParameterUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaParameterUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaParameterUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_creation_exception.py deleted file mode 100644 index 31ea74520..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_creation_exception.py +++ /dev/null @@ -1,267 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterValueErrorDetail]", - "message": "str", - "name": "str", - "parameter_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - "parameter_guid": "parameterGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterValueErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - parameter_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterValueCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterValueCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterValueCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterValueCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterValueCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterValueCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterValueCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterValueCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaParameterValueCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaParameterValueCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaParameterValueCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaParameterValueCreationException. - """ - self._name = name - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterValueCreationException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterValueCreationException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterValueCreationException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterValueCreationException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueCreationException. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueCreationException. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_deletion_exception.py index bcdfc294b..2db46d173 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_deletion_exception.py @@ -61,21 +61,19 @@ class GsaParameterValueDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaParameterValueDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaParameterValueDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaParameterValueDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaParameterValueDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaParameterValueDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaParameterValueDeletionException. - - Returns - ------- - str - The guid of this GsaParameterValueDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaParameterValueDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaParameterValueDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaParameterValueDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_detail.py deleted file mode 100644 index 14992b440..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaParameterValueErrorReason", - } - - discriminator_value_class_map = { - "inUse".lower(): "#/components/schemas/GsaInUseParameterValueErrorDetail", - "logScaleNegative".lower(): "#/components/schemas/GsaLogScaleNegativeParameterValueErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityParameterValueErrorDetail", - "nameWhitespace".lower(): "#/components/schemas/GsaNameWhitespaceParameterValueErrorDetail", - "parameterValueType".lower(): "#/components/schemas/GsaParameterValueTypeParameterValueErrorDetail", - "valueNotProvided".lower(): "#/components/schemas/GsaValueNotProvidedParameterValueErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason", - ) -> None: - """GsaParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - """ - self._message: str - self._reason: GsaParameterValueErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaParameterValueErrorDetail. - - Returns - ------- - str - The message of this GsaParameterValueErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaParameterValueErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaParameterValueErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaParameterValueErrorReason": - """Gets the reason of this GsaParameterValueErrorDetail. - - Returns - ------- - GsaParameterValueErrorReason - The reason of this GsaParameterValueErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaParameterValueErrorReason") -> None: - """Sets the reason of this GsaParameterValueErrorDetail. - - Parameters - ---------- - reason: GsaParameterValueErrorReason - The reason of this GsaParameterValueErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_reason.py deleted file mode 100644 index 657db23b6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterValueErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - INUSE = "inUse" - LOGSCALENEGATIVE = "logScaleNegative" - NAMEDENTITY = "namedEntity" - NAMEWHITESPACE = "nameWhitespace" - PARAMETERVALUETYPE = "parameterValueType" - VALUENOTPROVIDED = "valueNotProvided" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_parameter_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_parameter_error_detail.py deleted file mode 100644 index e2f51ea5f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_parameter_error_detail.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_detail import ( # noqa: F401 - GsaParameterErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_error_reason import ( - GsaParameterErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueParameterErrorDetail(GsaParameterErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterErrorReason", - "errors": "list[GsaParameterValueErrorDetail]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "errors": "errors", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterErrorReason" = GsaParameterErrorReason.PARAMETERVALUE, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueParameterErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterErrorReason - errors: list[GsaParameterValueErrorDetail] | None, optional - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if errors is not Unset: - self.errors = errors - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueParameterErrorDetail. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueParameterErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueParameterErrorDetail. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueParameterErrorDetail. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueParameterErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_type_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_type_parameter_value_error_detail.py deleted file mode 100644 index 7bccc4520..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_type_parameter_value_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueTypeParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "parameter_type": "GsaParameterType", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "parameter_type": "parameterType", - } - - subtype_mapping: dict[str, str] = { - "parameterType": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.PARAMETERVALUETYPE, - parameter_type: "GsaParameterType | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueTypeParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - parameter_type: GsaParameterType, optional - """ - super().__init__(message=message, reason=reason) - self._parameter_type: GsaParameterType | Unset_Type = Unset - - if parameter_type is not Unset: - self.parameter_type = parameter_type - - @property - def parameter_type(self) -> "GsaParameterType | Unset_Type": - """Gets the parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - - Returns - ------- - GsaParameterType | Unset_Type - The parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - """ - return self._parameter_type - - @parameter_type.setter - def parameter_type(self, parameter_type: "GsaParameterType | Unset_Type") -> None: - """Sets the parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - - Parameters - ---------- - parameter_type: GsaParameterType | Unset_Type - The parameter_type of this GsaParameterValueTypeParameterValueErrorDetail. - """ - # Field is not nullable - if parameter_type is None: - raise ValueError("Invalid value for 'parameter_type', must not be 'None'") - self._parameter_type = parameter_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueTypeParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_update_exception.py deleted file mode 100644 index 193d7a5a4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_update_exception.py +++ /dev/null @@ -1,270 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaParameterValueUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaParameterValueErrorDetail]", - "message": "str", - "parameter_guid": "str", - "parameter_value_guid": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "parameter_guid": "parameterGuid", - "parameter_value_guid": "parameterValueGuid", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaParameterValueErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - parameter_guid: "str | Unset_Type" = Unset, - parameter_value_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaParameterValueUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaParameterValueErrorDetail] | None, optional - message: str | None, optional - parameter_guid: str, optional - parameter_value_guid: str, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._parameter_value_guid: str | Unset_Type = Unset - self._parameter_guid: str | Unset_Type = Unset - self._errors: list[GsaParameterValueErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if parameter_value_guid is not Unset: - self.parameter_value_guid = parameter_value_guid - if parameter_guid is not Unset: - self.parameter_guid = parameter_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaParameterValueUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaParameterValueUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaParameterValueUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaParameterValueUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaParameterValueUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaParameterValueUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaParameterValueUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def parameter_value_guid(self) -> "str | Unset_Type": - """Gets the parameter_value_guid of this GsaParameterValueUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_value_guid of this GsaParameterValueUpdateException. - """ - return self._parameter_value_guid - - @parameter_value_guid.setter - def parameter_value_guid(self, parameter_value_guid: "str | Unset_Type") -> None: - """Sets the parameter_value_guid of this GsaParameterValueUpdateException. - - Parameters - ---------- - parameter_value_guid: str | Unset_Type - The parameter_value_guid of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if parameter_value_guid is None: - raise ValueError("Invalid value for 'parameter_value_guid', must not be 'None'") - self._parameter_value_guid = parameter_value_guid - - @property - def parameter_guid(self) -> "str | Unset_Type": - """Gets the parameter_guid of this GsaParameterValueUpdateException. - - Returns - ------- - str | Unset_Type - The parameter_guid of this GsaParameterValueUpdateException. - """ - return self._parameter_guid - - @parameter_guid.setter - def parameter_guid(self, parameter_guid: "str | Unset_Type") -> None: - """Sets the parameter_guid of this GsaParameterValueUpdateException. - - Parameters - ---------- - parameter_guid: str | Unset_Type - The parameter_guid of this GsaParameterValueUpdateException. - """ - # Field is not nullable - if parameter_guid is None: - raise ValueError("Invalid value for 'parameter_guid', must not be 'None'") - self._parameter_guid = parameter_guid - - @property - def errors(self) -> "list[GsaParameterValueErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaParameterValueUpdateException. - - Returns - ------- - list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaParameterValueErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaParameterValueUpdateException. - - Parameters - ---------- - errors: list[GsaParameterValueErrorDetail] | None | Unset_Type - The errors of this GsaParameterValueUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaParameterValueUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_used_by_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_used_by_type.py deleted file mode 100644 index 55ead834b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_parameter_value_used_by_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaParameterValueUsedByType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FUNCTIONALDATADEFAULT = "functionalDataDefault" - MULTIVALUEDPOINTDATA = "multiValuedPointData" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_access_control.py deleted file mode 100644 index 00a830549..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_access_control.py +++ /dev/null @@ -1,217 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "can_read": "bool", - "can_write": "bool", - "permission": "GsaSlimEntity", - } - - attribute_map: dict[str, str] = { - "can_read": "canRead", - "can_write": "canWrite", - "permission": "permission", - } - - subtype_mapping: dict[str, str] = { - "permission": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - can_read: "bool", - can_write: "bool", - permission: "GsaSlimEntity", - ) -> None: - """GsaPermissionAccessControl - a model defined in Swagger - - Parameters - ---------- - can_read: bool - can_write: bool - permission: GsaSlimEntity - """ - self._permission: GsaSlimEntity - self._can_read: bool - self._can_write: bool - - self.permission = permission - self.can_read = can_read - self.can_write = can_write - - @property - def permission(self) -> "GsaSlimEntity": - """Gets the permission of this GsaPermissionAccessControl. - - Returns - ------- - GsaSlimEntity - The permission of this GsaPermissionAccessControl. - """ - return self._permission - - @permission.setter - def permission(self, permission: "GsaSlimEntity") -> None: - """Sets the permission of this GsaPermissionAccessControl. - - Parameters - ---------- - permission: GsaSlimEntity - The permission of this GsaPermissionAccessControl. - """ - # Field is not nullable - if permission is None: - raise ValueError("Invalid value for 'permission', must not be 'None'") - # Field is required - if permission is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission', must not be 'Unset'") - self._permission = permission - - @property - def can_read(self) -> "bool": - """Gets the can_read of this GsaPermissionAccessControl. - - Returns - ------- - bool - The can_read of this GsaPermissionAccessControl. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool") -> None: - """Sets the can_read of this GsaPermissionAccessControl. - - Parameters - ---------- - can_read: bool - The can_read of this GsaPermissionAccessControl. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - # Field is required - if can_read is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_read', must not be 'Unset'") - self._can_read = can_read - - @property - def can_write(self) -> "bool": - """Gets the can_write of this GsaPermissionAccessControl. - - Returns - ------- - bool - The can_write of this GsaPermissionAccessControl. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaPermissionAccessControl. - - Parameters - ---------- - can_write: bool - The can_write of this GsaPermissionAccessControl. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - # Field is required - if can_write is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'can_write', must not be 'Unset'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_based_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_based_access_control_info.py deleted file mode 100644 index 79514bc39..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_based_access_control_info.py +++ /dev/null @@ -1,124 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_info import ( # noqa: F401 - GsaAccessControlInfo, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionBasedAccessControlInfo(GsaAccessControlInfo): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.PERMISSIONBASED, - ) -> None: - """GsaPermissionBasedAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionBasedAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_detail.py deleted file mode 100644 index b1045d589..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoriesAccessControlErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionCategoriesAccessControlErrorReason", - } - - discriminator_value_class_map = { - "noSuchCategory".lower(): "#/components/schemas/GsaNoSuchCategoryAccessControlErrorDetail", - "noSuchPermission".lower(): "#/components/schemas/GsaNoSuchPermissionAccessControlErrorDetail", - "duplicateCategoryGuids".lower(): "#/components/schemas/GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "duplicatePermissionGuids".lower(): "#/components/schemas/GsaDuplicatePermissionGuidsAccessControlErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoriesAccessControlErrorReason", - ) -> None: - """GsaPermissionCategoriesAccessControlErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoriesAccessControlErrorReason - """ - self._message: str - self._reason: GsaPermissionCategoriesAccessControlErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionCategoriesAccessControlErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionCategoriesAccessControlErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionCategoriesAccessControlErrorReason": - """Gets the reason of this GsaPermissionCategoriesAccessControlErrorDetail. - - Returns - ------- - GsaPermissionCategoriesAccessControlErrorReason - The reason of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionCategoriesAccessControlErrorReason") -> None: - """Sets the reason of this GsaPermissionCategoriesAccessControlErrorDetail. - - Parameters - ---------- - reason: GsaPermissionCategoriesAccessControlErrorReason - The reason of this GsaPermissionCategoriesAccessControlErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoriesAccessControlErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_reason.py deleted file mode 100644 index cf160b0ac..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionCategoriesAccessControlErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHPERMISSION = "noSuchPermission" - NOSUCHCATEGORY = "noSuchCategory" - DUPLICATECATEGORYGUIDS = "duplicateCategoryGuids" - DUPLICATEPERMISSIONGUIDS = "duplicatePermissionGuids" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_update_exception.py deleted file mode 100644 index 4c1b5c44b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_access_control_update_exception.py +++ /dev/null @@ -1,210 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoriesAccessControlUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoriesAccessControlErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoriesAccessControlErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoriesAccessControlUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type = ( - Unset - ) - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoriesAccessControlUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoriesAccessControlUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoriesAccessControlUpdateException. - - Returns - ------- - list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoriesAccessControlUpdateException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaPermissionCategoriesAccessControlUpdateException. - - Parameters - ---------- - errors: list[GsaPermissionCategoriesAccessControlErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoriesAccessControlUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoriesAccessControlUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_info.py index 7e943de8c..b1e618dcd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_categories_info.py @@ -61,7 +61,7 @@ class GsaPermissionCategoriesInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "categories": "list[GsaPermissionCategory]", + "categories": "list[GsaSlimPermissionCategory]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaPermissionCategoriesInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "categories": "GsaPermissionCategory", + "categories": "GsaSlimPermissionCategory", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaPermissionCategoriesInfo(ModelBase): def __init__( self, *, - categories: "list[GsaPermissionCategory]", + categories: "list[GsaSlimPermissionCategory]", ) -> None: """GsaPermissionCategoriesInfo - a model defined in Swagger Parameters ---------- - categories: list[GsaPermissionCategory] + categories: list[GsaSlimPermissionCategory] """ - self._categories: list[GsaPermissionCategory] + self._categories: list[GsaSlimPermissionCategory] self.categories = categories @property - def categories(self) -> "list[GsaPermissionCategory]": + def categories(self) -> "list[GsaSlimPermissionCategory]": """Gets the categories of this GsaPermissionCategoriesInfo. Returns ------- - list[GsaPermissionCategory] + list[GsaSlimPermissionCategory] The categories of this GsaPermissionCategoriesInfo. """ return self._categories @categories.setter - def categories(self, categories: "list[GsaPermissionCategory]") -> None: + def categories(self, categories: "list[GsaSlimPermissionCategory]") -> None: """Sets the categories of this GsaPermissionCategoriesInfo. Parameters ---------- - categories: list[GsaPermissionCategory] + categories: list[GsaSlimPermissionCategory] The categories of this GsaPermissionCategoriesInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category.py index e1a3b9cfb..564c80363 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category.py @@ -63,7 +63,7 @@ class GsaPermissionCategory(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "permissions": "list[GsaPermission]", + "permissions": "list[GsaSlimNamedEntity]", } attribute_map: dict[str, str] = { @@ -73,7 +73,7 @@ class GsaPermissionCategory(ModelBase): } subtype_mapping: dict[str, str] = { - "permissions": "GsaPermission", + "permissions": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -83,7 +83,7 @@ def __init__( *, guid: "str", name: "str", - permissions: "list[GsaPermission]", + permissions: "list[GsaSlimNamedEntity]", ) -> None: """GsaPermissionCategory - a model defined in Swagger @@ -91,9 +91,9 @@ def __init__( ---------- guid: str name: str - permissions: list[GsaPermission] + permissions: list[GsaSlimNamedEntity] """ - self._permissions: list[GsaPermission] + self._permissions: list[GsaSlimNamedEntity] self._name: str self._guid: str @@ -102,23 +102,23 @@ def __init__( self.guid = guid @property - def permissions(self) -> "list[GsaPermission]": + def permissions(self) -> "list[GsaSlimNamedEntity]": """Gets the permissions of this GsaPermissionCategory. Returns ------- - list[GsaPermission] + list[GsaSlimNamedEntity] The permissions of this GsaPermissionCategory. """ return self._permissions @permissions.setter - def permissions(self, permissions: "list[GsaPermission]") -> None: + def permissions(self, permissions: "list[GsaSlimNamedEntity]") -> None: """Sets the permissions of this GsaPermissionCategory. Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimNamedEntity] The permissions of this GsaPermissionCategory. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control.py deleted file mode 100644 index 421500118..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category": "GsaSlimEntity", - "permission_access_controls": "list[GsaPermissionAccessControl]", - } - - attribute_map: dict[str, str] = { - "category": "category", - "permission_access_controls": "permissionAccessControls", - } - - subtype_mapping: dict[str, str] = { - "category": "GsaSlimEntity", - "permissionAccessControls": "GsaPermissionAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category: "GsaSlimEntity", - permission_access_controls: "list[GsaPermissionAccessControl]", - ) -> None: - """GsaPermissionCategoryAccessControl - a model defined in Swagger - - Parameters - ---------- - category: GsaSlimEntity - permission_access_controls: list[GsaPermissionAccessControl] - """ - self._category: GsaSlimEntity - self._permission_access_controls: list[GsaPermissionAccessControl] - - self.category = category - self.permission_access_controls = permission_access_controls - - @property - def category(self) -> "GsaSlimEntity": - """Gets the category of this GsaPermissionCategoryAccessControl. - - Returns - ------- - GsaSlimEntity - The category of this GsaPermissionCategoryAccessControl. - """ - return self._category - - @category.setter - def category(self, category: "GsaSlimEntity") -> None: - """Sets the category of this GsaPermissionCategoryAccessControl. - - Parameters - ---------- - category: GsaSlimEntity - The category of this GsaPermissionCategoryAccessControl. - """ - # Field is not nullable - if category is None: - raise ValueError("Invalid value for 'category', must not be 'None'") - # Field is required - if category is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category', must not be 'Unset'") - self._category = category - - @property - def permission_access_controls(self) -> "list[GsaPermissionAccessControl]": - """Gets the permission_access_controls of this GsaPermissionCategoryAccessControl. - - Returns - ------- - list[GsaPermissionAccessControl] - The permission_access_controls of this GsaPermissionCategoryAccessControl. - """ - return self._permission_access_controls - - @permission_access_controls.setter - def permission_access_controls( - self, permission_access_controls: "list[GsaPermissionAccessControl]" - ) -> None: - """Sets the permission_access_controls of this GsaPermissionCategoryAccessControl. - - Parameters - ---------- - permission_access_controls: list[GsaPermissionAccessControl] - The permission_access_controls of this GsaPermissionCategoryAccessControl. - """ - # Field is not nullable - if permission_access_controls is None: - raise ValueError("Invalid value for 'permission_access_controls', must not be 'None'") - # Field is required - if permission_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_access_controls', must not be 'Unset'") - self._permission_access_controls = permission_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control_info.py deleted file mode 100644 index 888600cb5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_access_control_info.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryAccessControlInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_access_controls": "list[GsaPermissionCategoryAccessControl]", - } - - attribute_map: dict[str, str] = { - "category_access_controls": "categoryAccessControls", - } - - subtype_mapping: dict[str, str] = { - "categoryAccessControls": "GsaPermissionCategoryAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_access_controls: "list[GsaPermissionCategoryAccessControl] | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryAccessControlInfo - a model defined in Swagger - - Parameters - ---------- - category_access_controls: list[GsaPermissionCategoryAccessControl] | None, optional - """ - self._category_access_controls: ( - list[GsaPermissionCategoryAccessControl] | None | Unset_Type - ) = Unset - - if category_access_controls is not Unset: - self.category_access_controls = category_access_controls - - @property - def category_access_controls( - self, - ) -> "list[GsaPermissionCategoryAccessControl] | None | Unset_Type": - """Gets the category_access_controls of this GsaPermissionCategoryAccessControlInfo. - - Returns - ------- - list[GsaPermissionCategoryAccessControl] | None | Unset_Type - The category_access_controls of this GsaPermissionCategoryAccessControlInfo. - """ - return self._category_access_controls - - @category_access_controls.setter - def category_access_controls( - self, - category_access_controls: "list[GsaPermissionCategoryAccessControl] | None | Unset_Type", - ) -> None: - """Sets the category_access_controls of this GsaPermissionCategoryAccessControlInfo. - - Parameters - ---------- - category_access_controls: list[GsaPermissionCategoryAccessControl] | None | Unset_Type - The category_access_controls of this GsaPermissionCategoryAccessControlInfo. - """ - self._category_access_controls = category_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryAccessControlInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_creation_exception.py deleted file mode 100644 index 4e5ba46c0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoryCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoryCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaPermissionCategoryCreationException. - - Returns - ------- - str - The name of this GsaPermissionCategoryCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - name: str - The name of this GsaPermissionCategoryCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryCreationException. - - Returns - ------- - list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCategoryCreationException. - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_detail.py deleted file mode 100644 index f6cd17c0c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionCategoryErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "noPermissions".lower(): "#/components/schemas/GsaNoPermissionsPermissionCategoryErrorDetail", - "tooManyPermissions".lower(): "#/components/schemas/GsaTooManyPermissionsPermissionCategoryErrorDetail", - "duplicatePermissions".lower(): "#/components/schemas/GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "permission".lower(): "#/components/schemas/GsaPermissionPermissionCategoryErrorDetail", - "noSuchPermissions".lower(): "#/components/schemas/GsaNoSuchPermissionsPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionCategoryErrorReason", - ) -> None: - """GsaPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionCategoryErrorReason - """ - self._message: str - self._reason: GsaPermissionCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionCategoryErrorReason": - """Gets the reason of this GsaPermissionCategoryErrorDetail. - - Returns - ------- - GsaPermissionCategoryErrorReason - The reason of this GsaPermissionCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionCategoryErrorReason") -> None: - """Sets the reason of this GsaPermissionCategoryErrorDetail. - - Parameters - ---------- - reason: GsaPermissionCategoryErrorReason - The reason of this GsaPermissionCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_reason.py deleted file mode 100644 index 96cf6afe4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - NOPERMISSIONS = "noPermissions" - TOOMANYPERMISSIONS = "tooManyPermissions" - DUPLICATEPERMISSIONS = "duplicatePermissions" - PERMISSION = "permission" - NOSUCHPERMISSIONS = "noSuchPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_replace_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_replace_exception.py deleted file mode 100644 index 0c12f16e0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_replace_exception.py +++ /dev/null @@ -1,208 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryReplaceException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaReplacePermissionCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaReplacePermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryReplaceException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaReplacePermissionCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryReplaceException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoryReplaceException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoryReplaceException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryReplaceException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryReplaceException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryReplaceException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryReplaceException. - - Returns - ------- - list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryReplaceException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaPermissionCategoryReplaceException. - - Parameters - ---------- - errors: list[GsaReplacePermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryReplaceException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryReplaceException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_update_exception.py deleted file mode 100644 index 212fcccdf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_category_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCategoryUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionCategoryErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCategoryUpdateException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionCategoryErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCategoryUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCategoryUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCategoryUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCategoryUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCategoryUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCategoryUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCategoryUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionCategoryUpdateException. - - Returns - ------- - str - The guid of this GsaPermissionCategoryUpdateException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionCategoryUpdateException. - - Parameters - ---------- - guid: str - The guid of this GsaPermissionCategoryUpdateException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCategoryUpdateException. - - Returns - ------- - list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionCategoryErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCategoryUpdateException. - - Parameters - ---------- - errors: list[GsaPermissionCategoryErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCategoryUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCategoryUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_creation_exception.py deleted file mode 100644 index 4e0b6611d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaPermissionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaPermissionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaPermissionCreationException. - - Returns - ------- - str - The name of this GsaPermissionCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaPermissionCreationException. - - Parameters - ---------- - name: str - The name of this GsaPermissionCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaPermissionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionCreationException. - - Returns - ------- - list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionCreationException. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_detail.py deleted file mode 100644 index 9a823b85d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_detail.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionDeletionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionDeletionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionDeletionErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionDeletionErrorReason | Unset_Type" = Unset, - ) -> None: - """GsaPermissionDeletionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionDeletionErrorReason, optional - """ - self._message: str - self._reason: GsaPermissionDeletionErrorReason | Unset_Type = Unset - - self.message = message - if reason is not Unset: - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionDeletionErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionDeletionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionDeletionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionDeletionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionDeletionErrorReason | Unset_Type": - """Gets the reason of this GsaPermissionDeletionErrorDetail. - - Returns - ------- - GsaPermissionDeletionErrorReason | Unset_Type - The reason of this GsaPermissionDeletionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionDeletionErrorReason | Unset_Type") -> None: - """Sets the reason of this GsaPermissionDeletionErrorDetail. - - Parameters - ---------- - reason: GsaPermissionDeletionErrorReason | Unset_Type - The reason of this GsaPermissionDeletionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionDeletionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_reason.py deleted file mode 100644 index 3f6036266..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CATEGORYMUSTHAVEPERMISSIONS = "categoryMustHavePermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_exception.py deleted file mode 100644 index c62df4fac..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_deletion_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionDeletionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionDeletionException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionDeletionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionDeletionException. - - Returns - ------- - str - The guid of this GsaPermissionDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaPermissionDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionDeletionException. - - Returns - ------- - list[GsaPermissionDeletionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionDeletionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionDeletionException. - - Parameters - ---------- - errors: list[GsaPermissionDeletionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_detail.py deleted file mode 100644 index e7470c9aa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_detail.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaPermissionErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "roleNotProvided".lower(): "#/components/schemas/GsaRoleNotProvidedPermissionErrorDetail", - "maxPermissionsReached".lower(): "#/components/schemas/GsaMaxPermissionsReachedPermissionErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionErrorReason", - ) -> None: - """GsaPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionErrorReason - """ - self._message: str - self._reason: GsaPermissionErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaPermissionErrorDetail. - - Returns - ------- - str - The message of this GsaPermissionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaPermissionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaPermissionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaPermissionErrorReason": - """Gets the reason of this GsaPermissionErrorDetail. - - Returns - ------- - GsaPermissionErrorReason - The reason of this GsaPermissionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaPermissionErrorReason") -> None: - """Sets the reason of this GsaPermissionErrorDetail. - - Parameters - ---------- - reason: GsaPermissionErrorReason - The reason of this GsaPermissionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_reason.py deleted file mode 100644 index 0b0900ca2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_error_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPermissionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - ROLENOTPROVIDED = "roleNotProvided" - MAXPERMISSIONSREACHED = "maxPermissionsReached" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_permission_category_error_detail.py deleted file mode 100644 index 483145071..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_permission_category_error_detail.py +++ /dev/null @@ -1,223 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - "reason": "GsaPermissionCategoryErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaPermissionErrorDetail]", - message: "str", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.PERMISSION, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] - message: str - reason: GsaPermissionCategoryErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - self._errors: list[GsaPermissionErrorDetail] - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - self.errors = errors - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaPermissionPermissionCategoryErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaPermissionPermissionCategoryErrorDetail. - """ - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionErrorDetail]": - """Gets the errors of this GsaPermissionPermissionCategoryErrorDetail. - - Returns - ------- - list[GsaPermissionErrorDetail] - The errors of this GsaPermissionPermissionCategoryErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail]") -> None: - """Sets the errors of this GsaPermissionPermissionCategoryErrorDetail. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] - The errors of this GsaPermissionPermissionCategoryErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_update_exception.py deleted file mode 100644 index f93b4f195..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permission_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPermissionUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaPermissionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaPermissionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaPermissionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaPermissionUpdateException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaPermissionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaPermissionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaPermissionUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaPermissionUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaPermissionUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaPermissionUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaPermissionUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaPermissionUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaPermissionUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaPermissionUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaPermissionUpdateException. - - Returns - ------- - str - The guid of this GsaPermissionUpdateException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaPermissionUpdateException. - - Parameters - ---------- - guid: str - The guid of this GsaPermissionUpdateException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaPermissionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaPermissionUpdateException. - - Returns - ------- - list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaPermissionErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaPermissionUpdateException. - - Parameters - ---------- - errors: list[GsaPermissionErrorDetail] | None | Unset_Type - The errors of this GsaPermissionUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPermissionUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permissions_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permissions_info.py index 5bdbcd419..1f41bd861 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permissions_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_permissions_info.py @@ -61,7 +61,7 @@ class GsaPermissionsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "permissions": "list[GsaPermission]", + "permissions": "list[GsaSlimPermission]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaPermissionsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "permissions": "GsaPermission", + "permissions": "GsaSlimPermission", } discriminator: Optional[str] = None @@ -77,36 +77,36 @@ class GsaPermissionsInfo(ModelBase): def __init__( self, *, - permissions: "list[GsaPermission]", + permissions: "list[GsaSlimPermission]", ) -> None: """GsaPermissionsInfo - a model defined in Swagger Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimPermission] """ - self._permissions: list[GsaPermission] + self._permissions: list[GsaSlimPermission] self.permissions = permissions @property - def permissions(self) -> "list[GsaPermission]": + def permissions(self) -> "list[GsaSlimPermission]": """Gets the permissions of this GsaPermissionsInfo. Returns ------- - list[GsaPermission] + list[GsaSlimPermission] The permissions of this GsaPermissionsInfo. """ return self._permissions @permissions.setter - def permissions(self, permissions: "list[GsaPermission]") -> None: + def permissions(self, permissions: "list[GsaSlimPermission]") -> None: """Sets the permissions of this GsaPermissionsInfo. Parameters ---------- - permissions: list[GsaPermission] + permissions: list[GsaSlimPermission] The permissions of this GsaPermissionsInfo. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_picture_attribute.py index 0e01fe96a..634c84abb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_picture_attribute.py @@ -69,7 +69,6 @@ class GsaPictureAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -84,7 +83,6 @@ class GsaPictureAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -105,7 +103,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.PICTURE, @@ -122,7 +119,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -136,7 +132,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_attribute.py index 20d7f6b52..b3f900277 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_attribute.py @@ -71,7 +71,6 @@ class GsaPointAttribute(GsaAttribute): "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -89,7 +88,6 @@ class GsaPointAttribute(GsaAttribute): "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -116,7 +114,6 @@ def __init__( info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", is_multi_valued: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.POINT, @@ -136,7 +133,6 @@ def __init__( info: GsaAttributeInfo is_hidden_from_search_criteria: bool is_multi_valued: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -151,7 +147,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_chart_data.py deleted file mode 100644 index 07b619d90..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_point_chart_data.py +++ /dev/null @@ -1,226 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPointChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "estimated": "bool", - "parameter_values": "str", - "record_version_guid": "str", - "value": "float", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "estimated": "estimated", - "parameter_values": "parameterValues", - "record_version_guid": "recordVersionGuid", - "value": "value", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.POINT, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - estimated: "bool | Unset_Type" = Unset, - parameter_values: "str | None | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - value: "float | Unset_Type" = Unset, - ) -> None: - """GsaPointChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - estimated: bool, optional - parameter_values: str | None, optional - record_version_guid: str, optional - value: float, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._value: float | Unset_Type = Unset - self._estimated: bool | Unset_Type = Unset - self._parameter_values: str | None | Unset_Type = Unset - - if value is not Unset: - self.value = value - if estimated is not Unset: - self.estimated = estimated - if parameter_values is not Unset: - self.parameter_values = parameter_values - - @property - def value(self) -> "float | Unset_Type": - """Gets the value of this GsaPointChartData. - - Returns - ------- - float | Unset_Type - The value of this GsaPointChartData. - """ - return self._value - - @value.setter - def value(self, value: "float | Unset_Type") -> None: - """Sets the value of this GsaPointChartData. - - Parameters - ---------- - value: float | Unset_Type - The value of this GsaPointChartData. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - self._value = value - - @property - def estimated(self) -> "bool | Unset_Type": - """Gets the estimated of this GsaPointChartData. - - Returns - ------- - bool | Unset_Type - The estimated of this GsaPointChartData. - """ - return self._estimated - - @estimated.setter - def estimated(self, estimated: "bool | Unset_Type") -> None: - """Sets the estimated of this GsaPointChartData. - - Parameters - ---------- - estimated: bool | Unset_Type - The estimated of this GsaPointChartData. - """ - # Field is not nullable - if estimated is None: - raise ValueError("Invalid value for 'estimated', must not be 'None'") - self._estimated = estimated - - @property - def parameter_values(self) -> "str | None | Unset_Type": - """Gets the parameter_values of this GsaPointChartData. - - Returns - ------- - str | None | Unset_Type - The parameter_values of this GsaPointChartData. - """ - return self._parameter_values - - @parameter_values.setter - def parameter_values(self, parameter_values: "str | None | Unset_Type") -> None: - """Sets the parameter_values of this GsaPointChartData. - - Parameters - ---------- - parameter_values: str | None | Unset_Type - The parameter_values of this GsaPointChartData. - """ - self._parameter_values = parameter_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPointChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_layout_item.py deleted file mode 100644 index f094d40b9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_layout_item.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutLayoutItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutLayoutItem", - "update".lower(): "#/components/schemas/GsaUpdatePutLayoutItem", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutLayoutItem - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutLayoutItem. - - Returns - ------- - GsaPutType - The type of this GsaPutLayoutItem. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutLayoutItem. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutLayoutItem. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission.py deleted file mode 100644 index 0546d5f1a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutPermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutPermission", - "update".lower(): "#/components/schemas/GsaUpdatePutPermission", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutPermission - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutPermission. - - Returns - ------- - GsaPutType - The type of this GsaPutPermission. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutPermission. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutPermission. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission_category.py deleted file mode 100644 index bf35e9270..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_permission_category.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaPutPermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaPutType", - } - - discriminator_value_class_map = { - "create".lower(): "#/components/schemas/GsaCreatePutPermissionCategory", - "update".lower(): "#/components/schemas/GsaUpdatePutPermissionCategory", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - type: "GsaPutType", - ) -> None: - """GsaPutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - type: GsaPutType - """ - self._type: GsaPutType - - self.type = type - - @property - def type(self) -> "GsaPutType": - """Gets the type of this GsaPutPermissionCategory. - - Returns - ------- - GsaPutType - The type of this GsaPutPermissionCategory. - """ - return self._type - - @type.setter - def type(self, type: "GsaPutType") -> None: - """Sets the type of this GsaPutPermissionCategory. - - Parameters - ---------- - type: GsaPutType - The type of this GsaPutPermissionCategory. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaPutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_type.py deleted file mode 100644 index 0ec53480f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_put_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaPutType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - CREATE = "create" - UPDATE = "update" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system.py deleted file mode 100644 index 1d6435821..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "type": "GsaQualitySystemType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "type": "type", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaQualitySystemType", - } - - discriminator_value_class_map = { - "discrete".lower(): "#/components/schemas/GsaDiscreteQualitySystem", - "continuous".lower(): "#/components/schemas/GsaContinuousQualitySystem", - } - - discriminator: Optional[str] = "type" - - def __init__( - self, - *, - guid: "str", - name: "str", - type: "GsaQualitySystemType", - ) -> None: - """GsaQualitySystem - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - type: GsaQualitySystemType - """ - self._type: GsaQualitySystemType - self._name: str - self._guid: str - - self.type = type - self.name = name - self.guid = guid - - @property - def type(self) -> "GsaQualitySystemType": - """Gets the type of this GsaQualitySystem. - - Returns - ------- - GsaQualitySystemType - The type of this GsaQualitySystem. - """ - return self._type - - @type.setter - def type(self, type: "GsaQualitySystemType") -> None: - """Sets the type of this GsaQualitySystem. - - Parameters - ---------- - type: GsaQualitySystemType - The type of this GsaQualitySystem. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def name(self) -> "str": - """Gets the name of this GsaQualitySystem. - - Returns - ------- - str - The name of this GsaQualitySystem. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaQualitySystem. - - Parameters - ---------- - name: str - The name of this GsaQualitySystem. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaQualitySystem. - - Returns - ------- - str - The guid of this GsaQualitySystem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaQualitySystem. - - Parameters - ---------- - guid: str - The guid of this GsaQualitySystem. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_guid_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_guid_error_detail.py deleted file mode 100644 index 0f702fd8f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_guid_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemGuidErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.QUALITYSYSTEMGUID, - ) -> None: - """GsaQualitySystemGuidErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemGuidErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_type.py deleted file mode 100644 index eb5e1d4c6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_system_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaQualitySystemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DISCRETE = "discrete" - CONTINUOUS = "continuous" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_systems_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_systems_info.py deleted file mode 100644 index 043d25ba5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_systems_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQualitySystemsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "quality_systems": "list[GsaQualitySystem]", - } - - attribute_map: dict[str, str] = { - "quality_systems": "qualitySystems", - } - - subtype_mapping: dict[str, str] = { - "qualitySystems": "GsaQualitySystem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - quality_systems: "list[GsaQualitySystem] | None | Unset_Type" = Unset, - ) -> None: - """GsaQualitySystemsInfo - a model defined in Swagger - - Parameters - ---------- - quality_systems: list[GsaQualitySystem] | None, optional - """ - self._quality_systems: list[GsaQualitySystem] | None | Unset_Type = Unset - - if quality_systems is not Unset: - self.quality_systems = quality_systems - - @property - def quality_systems(self) -> "list[GsaQualitySystem] | None | Unset_Type": - """Gets the quality_systems of this GsaQualitySystemsInfo. - - Returns - ------- - list[GsaQualitySystem] | None | Unset_Type - The quality_systems of this GsaQualitySystemsInfo. - """ - return self._quality_systems - - @quality_systems.setter - def quality_systems( - self, quality_systems: "list[GsaQualitySystem] | None | Unset_Type" - ) -> None: - """Sets the quality_systems of this GsaQualitySystemsInfo. - - Parameters - ---------- - quality_systems: list[GsaQualitySystem] | None | Unset_Type - The quality_systems of this GsaQualitySystemsInfo. - """ - self._quality_systems = quality_systems - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQualitySystemsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute.py index 42aa25a3d..672d721ad 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute.py @@ -70,15 +70,12 @@ class GsaQueryAttribute(ModelBase): "display_names": "dict(str, str)", "expressions": "list[GsaQuerySlimNamedEntity]", "guid": "str", - "help_path": "str", "info": "GsaQueryAttributeInfo", "is_functional_range": "bool", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "str", - "table": "GsaQuerySlimEntity", - "tabular_columns": "list[GsaQueryTabularColumn]", + "tabular_columns": "list[GsaQuerySlimNamedEntity]", "target": "GsaQueryTabularAttributeTarget", "type": "GsaAttributeType", "unit": "GsaQueryUnit", @@ -94,14 +91,11 @@ class GsaQueryAttribute(ModelBase): "display_names": "displayNames", "expressions": "expressions", "guid": "guid", - "help_path": "helpPath", "info": "info", "is_functional_range": "isFunctionalRange", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", - "table": "table", "tabular_columns": "tabularColumns", "target": "target", "type": "type", @@ -113,13 +107,12 @@ class GsaQueryAttribute(ModelBase): "defaultThresholdType": "GsaAttributeThresholdType", "axisName": "GsaQueryAxisName", "info": "GsaQueryAttributeInfo", - "table": "GsaQuerySlimEntity", "unit": "GsaQueryUnit", "discreteType": "GsaQuerySlimDiscreteType", "dataRule": "GsaQueryDataRule", "target": "GsaQueryTabularAttributeTarget", "aboutAttribute": "GsaQuerySlimTypedAttribute", - "tabularColumns": "GsaQueryTabularColumn", + "tabularColumns": "GsaQuerySlimNamedEntity", "attributeParameters": "GsaQuerySlimNamedEntity", "expressions": "GsaQuerySlimNamedEntity", } @@ -138,15 +131,12 @@ def __init__( display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, - help_path: "str | None | Unset_Type" = Unset, info: "GsaQueryAttributeInfo | Unset_Type" = Unset, is_functional_range: "bool | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - table: "GsaQuerySlimEntity | Unset_Type" = Unset, - tabular_columns: "list[GsaQueryTabularColumn] | None | Unset_Type" = Unset, + tabular_columns: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, target: "GsaQueryTabularAttributeTarget | Unset_Type" = Unset, type: "GsaAttributeType | Unset_Type" = Unset, unit: "GsaQueryUnit | Unset_Type" = Unset, @@ -164,43 +154,35 @@ def __init__( display_names: dict[str, str] | None, optional expressions: list[GsaQuerySlimNamedEntity] | None, optional guid: str | None, optional - help_path: str | None, optional info: GsaQueryAttributeInfo, optional is_functional_range: bool | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool | None, optional - is_protected: bool | None, optional name: str | None, optional - table: GsaQuerySlimEntity, optional - tabular_columns: list[GsaQueryTabularColumn] | None, optional + tabular_columns: list[GsaQuerySlimNamedEntity] | None, optional target: GsaQueryTabularAttributeTarget, optional type: GsaAttributeType, optional unit: GsaQueryUnit, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._type: GsaAttributeType | Unset_Type = Unset self._default_threshold_type: GsaAttributeThresholdType | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset self._is_multi_valued: bool | None | Unset_Type = Unset self._is_functional_range: bool | None | Unset_Type = Unset - self._help_path: str | None | Unset_Type = Unset self._axis_name: GsaQueryAxisName | Unset_Type = Unset self._info: GsaQueryAttributeInfo | Unset_Type = Unset - self._table: GsaQuerySlimEntity | Unset_Type = Unset self._unit: GsaQueryUnit | Unset_Type = Unset self._discrete_type: GsaQuerySlimDiscreteType | Unset_Type = Unset self._data_rule: GsaQueryDataRule | Unset_Type = Unset self._target: GsaQueryTabularAttributeTarget | Unset_Type = Unset self._about_attribute: GsaQuerySlimTypedAttribute | Unset_Type = Unset - self._tabular_columns: list[GsaQueryTabularColumn] | None | Unset_Type = Unset + self._tabular_columns: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._attribute_parameters: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._expressions: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset self._guid: str | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if type is not Unset: self.type = type if default_threshold_type is not Unset: @@ -211,14 +193,10 @@ def __init__( self.is_multi_valued = is_multi_valued if is_functional_range is not Unset: self.is_functional_range = is_functional_range - if help_path is not Unset: - self.help_path = help_path if axis_name is not Unset: self.axis_name = axis_name if info is not Unset: self.info = info - if table is not Unset: - self.table = table if unit is not Unset: self.unit = unit if discrete_type is not Unset: @@ -242,28 +220,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryAttribute. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryAttribute. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryAttribute. - """ - self._is_protected = is_protected - @property def type(self) -> "GsaAttributeType | Unset_Type": """Gets the type of this GsaQueryAttribute. @@ -384,28 +340,6 @@ def is_functional_range(self, is_functional_range: "bool | None | Unset_Type") - """ self._is_functional_range = is_functional_range - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaQueryAttribute. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaQueryAttribute. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaQueryAttribute. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaQueryAttribute. - """ - self._help_path = help_path - @property def axis_name(self) -> "GsaQueryAxisName | Unset_Type": """Gets the axis_name of this GsaQueryAttribute. @@ -456,31 +390,6 @@ def info(self, info: "GsaQueryAttributeInfo | Unset_Type") -> None: raise ValueError("Invalid value for 'info', must not be 'None'") self._info = info - @property - def table(self) -> "GsaQuerySlimEntity | Unset_Type": - """Gets the table of this GsaQueryAttribute. - - Returns - ------- - GsaQuerySlimEntity | Unset_Type - The table of this GsaQueryAttribute. - """ - return self._table - - @table.setter - def table(self, table: "GsaQuerySlimEntity | Unset_Type") -> None: - """Sets the table of this GsaQueryAttribute. - - Parameters - ---------- - table: GsaQuerySlimEntity | Unset_Type - The table of this GsaQueryAttribute. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - self._table = table - @property def unit(self) -> "GsaQueryUnit | Unset_Type": """Gets the unit of this GsaQueryAttribute. @@ -607,25 +516,25 @@ def about_attribute(self, about_attribute: "GsaQuerySlimTypedAttribute | Unset_T self._about_attribute = about_attribute @property - def tabular_columns(self) -> "list[GsaQueryTabularColumn] | None | Unset_Type": + def tabular_columns(self) -> "list[GsaQuerySlimNamedEntity] | None | Unset_Type": """Gets the tabular_columns of this GsaQueryAttribute. Returns ------- - list[GsaQueryTabularColumn] | None | Unset_Type + list[GsaQuerySlimNamedEntity] | None | Unset_Type The tabular_columns of this GsaQueryAttribute. """ return self._tabular_columns @tabular_columns.setter def tabular_columns( - self, tabular_columns: "list[GsaQueryTabularColumn] | None | Unset_Type" + self, tabular_columns: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" ) -> None: """Sets the tabular_columns of this GsaQueryAttribute. Parameters ---------- - tabular_columns: list[GsaQueryTabularColumn] | None | Unset_Type + tabular_columns: list[GsaQuerySlimNamedEntity] | None | Unset_Type The tabular_columns of this GsaQueryAttribute. """ self._tabular_columns = tabular_columns diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_filter.py index 6b0341f46..42ab08515 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_filter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_filter.py @@ -61,14 +61,12 @@ class GsaQueryAttributeFilter(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "discrete_type": "GsaQuerySlimNamedEntityFilter", "guid": "list[str]", "name": "list[str]", "type": "list[GsaAttributeType]", } attribute_map: dict[str, str] = { - "discrete_type": "discreteType", "guid": "guid", "name": "name", "type": "type", @@ -76,7 +74,6 @@ class GsaQueryAttributeFilter(ModelBase): subtype_mapping: dict[str, str] = { "type": "GsaAttributeType", - "discreteType": "GsaQuerySlimNamedEntityFilter", } discriminator: Optional[str] = None @@ -84,7 +81,6 @@ class GsaQueryAttributeFilter(ModelBase): def __init__( self, *, - discrete_type: "GsaQuerySlimNamedEntityFilter | Unset_Type" = Unset, guid: "list[str] | None | Unset_Type" = Unset, name: "list[str] | None | Unset_Type" = Unset, type: "list[GsaAttributeType] | None | Unset_Type" = Unset, @@ -93,7 +89,6 @@ def __init__( Parameters ---------- - discrete_type: GsaQuerySlimNamedEntityFilter, optional guid: list[str] | None, optional name: list[str] | None, optional type: list[GsaAttributeType] | None, optional @@ -101,7 +96,6 @@ def __init__( self._type: list[GsaAttributeType] | None | Unset_Type = Unset self._name: list[str] | None | Unset_Type = Unset self._guid: list[str] | None | Unset_Type = Unset - self._discrete_type: GsaQuerySlimNamedEntityFilter | Unset_Type = Unset if type is not Unset: self.type = type @@ -109,8 +103,6 @@ def __init__( self.name = name if guid is not Unset: self.guid = guid - if discrete_type is not Unset: - self.discrete_type = discrete_type @property def type(self) -> "list[GsaAttributeType] | None | Unset_Type": @@ -184,31 +176,6 @@ def guid(self, guid: "list[str] | None | Unset_Type") -> None: """ self._guid = guid - @property - def discrete_type(self) -> "GsaQuerySlimNamedEntityFilter | Unset_Type": - """Gets the discrete_type of this GsaQueryAttributeFilter. - - Returns - ------- - GsaQuerySlimNamedEntityFilter | Unset_Type - The discrete_type of this GsaQueryAttributeFilter. - """ - return self._discrete_type - - @discrete_type.setter - def discrete_type(self, discrete_type: "GsaQuerySlimNamedEntityFilter | Unset_Type") -> None: - """Sets the discrete_type of this GsaQueryAttributeFilter. - - Parameters - ---------- - discrete_type: GsaQuerySlimNamedEntityFilter | Unset_Type - The discrete_type of this GsaQueryAttributeFilter. - """ - # Field is not nullable - if discrete_type is None: - raise ValueError("Invalid value for 'discrete_type', must not be 'None'") - self._discrete_type = discrete_type - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_properties.py index ba5d842e4..274865b2c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_properties.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_attribute_properties.py @@ -70,15 +70,12 @@ class GsaQueryAttributeProperties(ModelBase): "display_names": "bool", "expressions": "GsaQuerySlimNamedEntityProperties", "guid": "bool", - "help_path": "bool", "info": "GsaQueryAttributeInfoProperties", "is_functional_range": "bool", "is_hidden_from_search_criteria": "bool", "is_multi_valued": "bool", - "is_protected": "bool", "name": "bool", - "table": "GsaQuerySlimEntityProperties", - "tabular_columns": "GsaQueryTabularColumnProperties", + "tabular_columns": "GsaQuerySlimNamedEntityProperties", "target": "GsaQueryTabularAttributeTargetProperties", "type": "bool", "unit": "GsaQueryUnitProperties", @@ -94,14 +91,11 @@ class GsaQueryAttributeProperties(ModelBase): "display_names": "displayNames", "expressions": "expressions", "guid": "guid", - "help_path": "helpPath", "info": "info", "is_functional_range": "isFunctionalRange", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", "is_multi_valued": "isMultiValued", - "is_protected": "isProtected", "name": "name", - "table": "table", "tabular_columns": "tabularColumns", "target": "target", "type": "type", @@ -111,13 +105,12 @@ class GsaQueryAttributeProperties(ModelBase): subtype_mapping: dict[str, str] = { "axisName": "GsaQueryAxisNameProperties", "info": "GsaQueryAttributeInfoProperties", - "table": "GsaQuerySlimEntityProperties", "unit": "GsaQueryUnitProperties", "discreteType": "GsaQuerySlimDiscreteTypeProperties", "dataRule": "GsaQueryDataRuleProperties", "aboutAttribute": "GsaQuerySlimTypedAttributeProperties", "target": "GsaQueryTabularAttributeTargetProperties", - "tabularColumns": "GsaQueryTabularColumnProperties", + "tabularColumns": "GsaQuerySlimNamedEntityProperties", "attributeParameters": "GsaQuerySlimNamedEntityProperties", "expressions": "GsaQuerySlimNamedEntityProperties", } @@ -136,15 +129,12 @@ def __init__( display_names: "bool | None | Unset_Type" = Unset, expressions: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, guid: "bool | None | Unset_Type" = Unset, - help_path: "bool | None | Unset_Type" = Unset, info: "GsaQueryAttributeInfoProperties | Unset_Type" = Unset, is_functional_range: "bool | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, is_multi_valued: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "bool | None | Unset_Type" = Unset, - table: "GsaQuerySlimEntityProperties | Unset_Type" = Unset, - tabular_columns: "GsaQueryTabularColumnProperties | Unset_Type" = Unset, + tabular_columns: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, target: "GsaQueryTabularAttributeTargetProperties | Unset_Type" = Unset, type: "bool | None | Unset_Type" = Unset, unit: "GsaQueryUnitProperties | Unset_Type" = Unset, @@ -162,43 +152,35 @@ def __init__( display_names: bool | None, optional expressions: GsaQuerySlimNamedEntityProperties, optional guid: bool | None, optional - help_path: bool | None, optional info: GsaQueryAttributeInfoProperties, optional is_functional_range: bool | None, optional is_hidden_from_search_criteria: bool | None, optional is_multi_valued: bool | None, optional - is_protected: bool | None, optional name: bool | None, optional - table: GsaQuerySlimEntityProperties, optional - tabular_columns: GsaQueryTabularColumnProperties, optional + tabular_columns: GsaQuerySlimNamedEntityProperties, optional target: GsaQueryTabularAttributeTargetProperties, optional type: bool | None, optional unit: GsaQueryUnitProperties, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._type: bool | None | Unset_Type = Unset self._default_threshold_type: bool | None | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset self._is_multi_valued: bool | None | Unset_Type = Unset self._is_functional_range: bool | None | Unset_Type = Unset - self._help_path: bool | None | Unset_Type = Unset self._axis_name: GsaQueryAxisNameProperties | Unset_Type = Unset self._info: GsaQueryAttributeInfoProperties | Unset_Type = Unset - self._table: GsaQuerySlimEntityProperties | Unset_Type = Unset self._unit: GsaQueryUnitProperties | Unset_Type = Unset self._discrete_type: GsaQuerySlimDiscreteTypeProperties | Unset_Type = Unset self._data_rule: GsaQueryDataRuleProperties | Unset_Type = Unset self._about_attribute: GsaQuerySlimTypedAttributeProperties | Unset_Type = Unset self._target: GsaQueryTabularAttributeTargetProperties | Unset_Type = Unset - self._tabular_columns: GsaQueryTabularColumnProperties | Unset_Type = Unset + self._tabular_columns: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._attribute_parameters: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._expressions: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._display_names: bool | None | Unset_Type = Unset self._name: bool | None | Unset_Type = Unset self._guid: bool | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if type is not Unset: self.type = type if default_threshold_type is not Unset: @@ -209,14 +191,10 @@ def __init__( self.is_multi_valued = is_multi_valued if is_functional_range is not Unset: self.is_functional_range = is_functional_range - if help_path is not Unset: - self.help_path = help_path if axis_name is not Unset: self.axis_name = axis_name if info is not Unset: self.info = info - if table is not Unset: - self.table = table if unit is not Unset: self.unit = unit if discrete_type is not Unset: @@ -240,28 +218,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryAttributeProperties. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryAttributeProperties. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryAttributeProperties. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryAttributeProperties. - """ - self._is_protected = is_protected - @property def type(self) -> "bool | None | Unset_Type": """Gets the type of this GsaQueryAttributeProperties. @@ -376,28 +332,6 @@ def is_functional_range(self, is_functional_range: "bool | None | Unset_Type") - """ self._is_functional_range = is_functional_range - @property - def help_path(self) -> "bool | None | Unset_Type": - """Gets the help_path of this GsaQueryAttributeProperties. - - Returns - ------- - bool | None | Unset_Type - The help_path of this GsaQueryAttributeProperties. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "bool | None | Unset_Type") -> None: - """Sets the help_path of this GsaQueryAttributeProperties. - - Parameters - ---------- - help_path: bool | None | Unset_Type - The help_path of this GsaQueryAttributeProperties. - """ - self._help_path = help_path - @property def axis_name(self) -> "GsaQueryAxisNameProperties | Unset_Type": """Gets the axis_name of this GsaQueryAttributeProperties. @@ -448,31 +382,6 @@ def info(self, info: "GsaQueryAttributeInfoProperties | Unset_Type") -> None: raise ValueError("Invalid value for 'info', must not be 'None'") self._info = info - @property - def table(self) -> "GsaQuerySlimEntityProperties | Unset_Type": - """Gets the table of this GsaQueryAttributeProperties. - - Returns - ------- - GsaQuerySlimEntityProperties | Unset_Type - The table of this GsaQueryAttributeProperties. - """ - return self._table - - @table.setter - def table(self, table: "GsaQuerySlimEntityProperties | Unset_Type") -> None: - """Sets the table of this GsaQueryAttributeProperties. - - Parameters - ---------- - table: GsaQuerySlimEntityProperties | Unset_Type - The table of this GsaQueryAttributeProperties. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - self._table = table - @property def unit(self) -> "GsaQueryUnitProperties | Unset_Type": """Gets the unit of this GsaQueryAttributeProperties. @@ -603,25 +512,25 @@ def target(self, target: "GsaQueryTabularAttributeTargetProperties | Unset_Type" self._target = target @property - def tabular_columns(self) -> "GsaQueryTabularColumnProperties | Unset_Type": + def tabular_columns(self) -> "GsaQuerySlimNamedEntityProperties | Unset_Type": """Gets the tabular_columns of this GsaQueryAttributeProperties. Returns ------- - GsaQueryTabularColumnProperties | Unset_Type + GsaQuerySlimNamedEntityProperties | Unset_Type The tabular_columns of this GsaQueryAttributeProperties. """ return self._tabular_columns @tabular_columns.setter def tabular_columns( - self, tabular_columns: "GsaQueryTabularColumnProperties | Unset_Type" + self, tabular_columns: "GsaQuerySlimNamedEntityProperties | Unset_Type" ) -> None: """Sets the tabular_columns of this GsaQueryAttributeProperties. Parameters ---------- - tabular_columns: GsaQueryTabularColumnProperties | Unset_Type + tabular_columns: GsaQuerySlimNamedEntityProperties | Unset_Type The tabular_columns of this GsaQueryAttributeProperties. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type.py index a20d30e80..8e69e5666 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type.py @@ -64,7 +64,6 @@ class GsaQueryDiscreteType(ModelBase): "discrete_values": "list[GsaQuerySlimNamedEntity]", "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } @@ -72,7 +71,6 @@ class GsaQueryDiscreteType(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "list[GsaQuerySlimNamedEntity] | None | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, is_ordered: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, ) -> None: """GsaQueryDiscreteType - a model defined in Swagger @@ -98,17 +95,13 @@ def __init__( discrete_values: list[GsaQuerySlimNamedEntity] | None, optional guid: str | None, optional is_ordered: bool | None, optional - is_protected: bool | None, optional name: str | None, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._discrete_values: list[GsaQuerySlimNamedEntity] | None | Unset_Type = Unset self._is_ordered: bool | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset self._guid: str | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if discrete_values is not Unset: self.discrete_values = discrete_values if is_ordered is not Unset: @@ -118,28 +111,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryDiscreteType. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryDiscreteType. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteType. - """ - self._is_protected = is_protected - @property def discrete_values(self) -> "list[GsaQuerySlimNamedEntity] | None | Unset_Type": """Gets the discrete_values of this GsaQueryDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type_properties.py index d0477de32..dd0b3a9c9 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type_properties.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_discrete_type_properties.py @@ -64,7 +64,6 @@ class GsaQueryDiscreteTypeProperties(ModelBase): "discrete_values": "GsaQuerySlimNamedEntityProperties", "guid": "bool", "is_ordered": "bool", - "is_protected": "bool", "name": "bool", } @@ -72,7 +71,6 @@ class GsaQueryDiscreteTypeProperties(ModelBase): "discrete_values": "discreteValues", "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -88,7 +86,6 @@ def __init__( discrete_values: "GsaQuerySlimNamedEntityProperties | Unset_Type" = Unset, guid: "bool | None | Unset_Type" = Unset, is_ordered: "bool | None | Unset_Type" = Unset, - is_protected: "bool | None | Unset_Type" = Unset, name: "bool | None | Unset_Type" = Unset, ) -> None: """GsaQueryDiscreteTypeProperties - a model defined in Swagger @@ -98,17 +95,13 @@ def __init__( discrete_values: GsaQuerySlimNamedEntityProperties, optional guid: bool | None, optional is_ordered: bool | None, optional - is_protected: bool | None, optional name: bool | None, optional """ - self._is_protected: bool | None | Unset_Type = Unset self._discrete_values: GsaQuerySlimNamedEntityProperties | Unset_Type = Unset self._is_ordered: bool | None | Unset_Type = Unset self._name: bool | None | Unset_Type = Unset self._guid: bool | None | Unset_Type = Unset - if is_protected is not Unset: - self.is_protected = is_protected if discrete_values is not Unset: self.discrete_values = discrete_values if is_ordered is not Unset: @@ -118,28 +111,6 @@ def __init__( if guid is not Unset: self.guid = guid - @property - def is_protected(self) -> "bool | None | Unset_Type": - """Gets the is_protected of this GsaQueryDiscreteTypeProperties. - - Returns - ------- - bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteTypeProperties. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool | None | Unset_Type") -> None: - """Sets the is_protected of this GsaQueryDiscreteTypeProperties. - - Parameters - ---------- - is_protected: bool | None | Unset_Type - The is_protected of this GsaQueryDiscreteTypeProperties. - """ - self._is_protected = is_protected - @property def discrete_values(self) -> "GsaQuerySlimNamedEntityProperties | Unset_Type": """Gets the discrete_values of this GsaQueryDiscreteTypeProperties. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout.py deleted file mode 100644 index 89316c46b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayout(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "sections": "list[GsaQueryLayoutSection]", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str] | None | Unset_Type" = Unset, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - sections: "list[GsaQueryLayoutSection] | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayout - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] | None, optional - guid: str | None, optional - name: str | None, optional - sections: list[GsaQueryLayoutSection] | None, optional - """ - self._sections: list[GsaQueryLayoutSection] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def sections(self) -> "list[GsaQueryLayoutSection] | None | Unset_Type": - """Gets the sections of this GsaQueryLayout. - - Returns - ------- - list[GsaQueryLayoutSection] | None | Unset_Type - The sections of this GsaQueryLayout. - """ - return self._sections - - @sections.setter - def sections(self, sections: "list[GsaQueryLayoutSection] | None | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayout. - - Parameters - ---------- - sections: list[GsaQueryLayoutSection] | None | Unset_Type - The sections of this GsaQueryLayout. - """ - self._sections = sections - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaQueryLayout. - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayout. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayout. - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayout. - """ - self._display_names = display_names - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayout. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayout. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayout. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayout. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayout. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayout. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayout. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayout. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayout): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_filter.py deleted file mode 100644 index aa5c4f0f8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_filter.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "sections": "GsaQueryLayoutSectionFilter", - } - - attribute_map: dict[str, str] = { - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSectionFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - sections: "GsaQueryLayoutSectionFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutFilter - a model defined in Swagger - - Parameters - ---------- - sections: GsaQueryLayoutSectionFilter, optional - """ - self._sections: GsaQueryLayoutSectionFilter | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - - @property - def sections(self) -> "GsaQueryLayoutSectionFilter | Unset_Type": - """Gets the sections of this GsaQueryLayoutFilter. - - Returns - ------- - GsaQueryLayoutSectionFilter | Unset_Type - The sections of this GsaQueryLayoutFilter. - """ - return self._sections - - @sections.setter - def sections(self, sections: "GsaQueryLayoutSectionFilter | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayoutFilter. - - Parameters - ---------- - sections: GsaQueryLayoutSectionFilter | Unset_Type - The sections of this GsaQueryLayoutFilter. - """ - # Field is not nullable - if sections is None: - raise ValueError("Invalid value for 'sections', must not be 'None'") - self._sections = sections - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item.py deleted file mode 100644 index 8d3687e4a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "item_type": "GsaLayoutItemType", - "name": "str", - "underlying_entity_guid": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "item_type": "itemType", - "name": "name", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaLayoutItemType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - item_type: "GsaLayoutItemType | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - underlying_entity_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItem - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - item_type: GsaLayoutItemType, optional - name: str | None, optional - underlying_entity_guid: str | None, optional - """ - self._underlying_entity_guid: str | None | Unset_Type = Unset - self._item_type: GsaLayoutItemType | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if item_type is not Unset: - self.item_type = item_type - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def underlying_entity_guid(self) -> "str | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItem. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "str | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItem. - - Parameters - ---------- - underlying_entity_guid: str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItem. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def item_type(self) -> "GsaLayoutItemType | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItem. - - Returns - ------- - GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaLayoutItemType | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItem. - - Parameters - ---------- - item_type: GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - self._item_type = item_type - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayoutItem. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutItem. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutItem. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutItem. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayoutItem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutItem. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayoutItem. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_filter.py deleted file mode 100644 index e2f9e6301..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_filter.py +++ /dev/null @@ -1,325 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItemFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "forwards": "bool", - "item_type": "GsaLayoutItemType", - "link_type": "GsaLayoutItemLinkType", - "target_database": "str", - "target_database_version": "str", - "target_table": "str", - "underlying_entity_guid": "str", - } - - attribute_map: dict[str, str] = { - "forwards": "forwards", - "item_type": "itemType", - "link_type": "linkType", - "target_database": "targetDatabase", - "target_database_version": "targetDatabaseVersion", - "target_table": "targetTable", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaLayoutItemType", - "linkType": "GsaLayoutItemLinkType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - forwards: "bool | None | Unset_Type" = Unset, - item_type: "GsaLayoutItemType | Unset_Type" = Unset, - link_type: "GsaLayoutItemLinkType | Unset_Type" = Unset, - target_database: "str | None | Unset_Type" = Unset, - target_database_version: "str | None | Unset_Type" = Unset, - target_table: "str | None | Unset_Type" = Unset, - underlying_entity_guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItemFilter - a model defined in Swagger - - Parameters - ---------- - forwards: bool | None, optional - item_type: GsaLayoutItemType, optional - link_type: GsaLayoutItemLinkType, optional - target_database: str | None, optional - target_database_version: str | None, optional - target_table: str | None, optional - underlying_entity_guid: str | None, optional - """ - self._item_type: GsaLayoutItemType | Unset_Type = Unset - self._underlying_entity_guid: str | None | Unset_Type = Unset - self._link_type: GsaLayoutItemLinkType | Unset_Type = Unset - self._target_database: str | None | Unset_Type = Unset - self._target_database_version: str | None | Unset_Type = Unset - self._target_table: str | None | Unset_Type = Unset - self._forwards: bool | None | Unset_Type = Unset - - if item_type is not Unset: - self.item_type = item_type - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if link_type is not Unset: - self.link_type = link_type - if target_database is not Unset: - self.target_database = target_database - if target_database_version is not Unset: - self.target_database_version = target_database_version - if target_table is not Unset: - self.target_table = target_table - if forwards is not Unset: - self.forwards = forwards - - @property - def item_type(self) -> "GsaLayoutItemType | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItemFilter. - - Returns - ------- - GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItemFilter. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaLayoutItemType | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - item_type: GsaLayoutItemType | Unset_Type - The item_type of this GsaQueryLayoutItemFilter. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - self._item_type = item_type - - @property - def underlying_entity_guid(self) -> "str | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemFilter. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "str | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - underlying_entity_guid: str | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemFilter. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def link_type(self) -> "GsaLayoutItemLinkType | Unset_Type": - """Gets the link_type of this GsaQueryLayoutItemFilter. - - Returns - ------- - GsaLayoutItemLinkType | Unset_Type - The link_type of this GsaQueryLayoutItemFilter. - """ - return self._link_type - - @link_type.setter - def link_type(self, link_type: "GsaLayoutItemLinkType | Unset_Type") -> None: - """Sets the link_type of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - link_type: GsaLayoutItemLinkType | Unset_Type - The link_type of this GsaQueryLayoutItemFilter. - """ - # Field is not nullable - if link_type is None: - raise ValueError("Invalid value for 'link_type', must not be 'None'") - self._link_type = link_type - - @property - def target_database(self) -> "str | None | Unset_Type": - """Gets the target_database of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_database of this GsaQueryLayoutItemFilter. - """ - return self._target_database - - @target_database.setter - def target_database(self, target_database: "str | None | Unset_Type") -> None: - """Sets the target_database of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_database: str | None | Unset_Type - The target_database of this GsaQueryLayoutItemFilter. - """ - self._target_database = target_database - - @property - def target_database_version(self) -> "str | None | Unset_Type": - """Gets the target_database_version of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_database_version of this GsaQueryLayoutItemFilter. - """ - return self._target_database_version - - @target_database_version.setter - def target_database_version(self, target_database_version: "str | None | Unset_Type") -> None: - """Sets the target_database_version of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_database_version: str | None | Unset_Type - The target_database_version of this GsaQueryLayoutItemFilter. - """ - self._target_database_version = target_database_version - - @property - def target_table(self) -> "str | None | Unset_Type": - """Gets the target_table of this GsaQueryLayoutItemFilter. - - Returns - ------- - str | None | Unset_Type - The target_table of this GsaQueryLayoutItemFilter. - """ - return self._target_table - - @target_table.setter - def target_table(self, target_table: "str | None | Unset_Type") -> None: - """Sets the target_table of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - target_table: str | None | Unset_Type - The target_table of this GsaQueryLayoutItemFilter. - """ - self._target_table = target_table - - @property - def forwards(self) -> "bool | None | Unset_Type": - """Gets the forwards of this GsaQueryLayoutItemFilter. - - Returns - ------- - bool | None | Unset_Type - The forwards of this GsaQueryLayoutItemFilter. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | None | Unset_Type") -> None: - """Sets the forwards of this GsaQueryLayoutItemFilter. - - Parameters - ---------- - forwards: bool | None | Unset_Type - The forwards of this GsaQueryLayoutItemFilter. - """ - self._forwards = forwards - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItemFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_properties.py deleted file mode 100644 index 8cec78da4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_item_properties.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutItemProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - "item_type": "bool", - "name": "bool", - "underlying_entity_guid": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "item_type": "itemType", - "name": "name", - "underlying_entity_guid": "underlyingEntityGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - item_type: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - underlying_entity_guid: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutItemProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - item_type: bool | None, optional - name: bool | None, optional - underlying_entity_guid: bool | None, optional - """ - self._underlying_entity_guid: bool | None | Unset_Type = Unset - self._item_type: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if underlying_entity_guid is not Unset: - self.underlying_entity_guid = underlying_entity_guid - if item_type is not Unset: - self.item_type = item_type - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def underlying_entity_guid(self) -> "bool | None | Unset_Type": - """Gets the underlying_entity_guid of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemProperties. - """ - return self._underlying_entity_guid - - @underlying_entity_guid.setter - def underlying_entity_guid(self, underlying_entity_guid: "bool | None | Unset_Type") -> None: - """Sets the underlying_entity_guid of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - underlying_entity_guid: bool | None | Unset_Type - The underlying_entity_guid of this GsaQueryLayoutItemProperties. - """ - self._underlying_entity_guid = underlying_entity_guid - - @property - def item_type(self) -> "bool | None | Unset_Type": - """Gets the item_type of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The item_type of this GsaQueryLayoutItemProperties. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "bool | None | Unset_Type") -> None: - """Sets the item_type of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - item_type: bool | None | Unset_Type - The item_type of this GsaQueryLayoutItemProperties. - """ - self._item_type = item_type - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutItemProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutItemProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutItemProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutItemProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutItemProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutItemProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutItemProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_properties.py deleted file mode 100644 index 4cb43b29f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_properties.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "bool", - "guid": "bool", - "name": "bool", - "sections": "GsaQueryLayoutSectionProperties", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "sections": "sections", - } - - subtype_mapping: dict[str, str] = { - "sections": "GsaQueryLayoutSectionProperties", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "bool | None | Unset_Type" = Unset, - guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - sections: "GsaQueryLayoutSectionProperties | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutProperties - a model defined in Swagger - - Parameters - ---------- - display_names: bool | None, optional - guid: bool | None, optional - name: bool | None, optional - sections: GsaQueryLayoutSectionProperties, optional - """ - self._sections: GsaQueryLayoutSectionProperties | Unset_Type = Unset - self._display_names: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if sections is not Unset: - self.sections = sections - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def sections(self) -> "GsaQueryLayoutSectionProperties | Unset_Type": - """Gets the sections of this GsaQueryLayoutProperties. - - Returns - ------- - GsaQueryLayoutSectionProperties | Unset_Type - The sections of this GsaQueryLayoutProperties. - """ - return self._sections - - @sections.setter - def sections(self, sections: "GsaQueryLayoutSectionProperties | Unset_Type") -> None: - """Sets the sections of this GsaQueryLayoutProperties. - - Parameters - ---------- - sections: GsaQueryLayoutSectionProperties | Unset_Type - The sections of this GsaQueryLayoutProperties. - """ - # Field is not nullable - if sections is None: - raise ValueError("Invalid value for 'sections', must not be 'None'") - self._sections = sections - - @property - def display_names(self) -> "bool | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The display_names of this GsaQueryLayoutProperties. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "bool | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutProperties. - - Parameters - ---------- - display_names: bool | None | Unset_Type - The display_names of this GsaQueryLayoutProperties. - """ - self._display_names = display_names - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section.py deleted file mode 100644 index 5db6dbdc3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "section_items": "list[GsaQueryLayoutItem]", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str] | None | Unset_Type" = Unset, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - section_items: "list[GsaQueryLayoutItem] | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSection - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] | None, optional - guid: str | None, optional - name: str | None, optional - section_items: list[GsaQueryLayoutItem] | None, optional - """ - self._section_items: list[GsaQueryLayoutItem] | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "list[GsaQueryLayoutItem] | None | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSection. - - Returns - ------- - list[GsaQueryLayoutItem] | None | Unset_Type - The section_items of this GsaQueryLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaQueryLayoutItem] | None | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSection. - - Parameters - ---------- - section_items: list[GsaQueryLayoutItem] | None | Unset_Type - The section_items of this GsaQueryLayoutSection. - """ - self._section_items = section_items - - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutSection. - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayoutSection. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutSection. - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaQueryLayoutSection. - """ - self._display_names = display_names - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSection. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryLayoutSection. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSection. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryLayoutSection. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutSection. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryLayoutSection. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutSection. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryLayoutSection. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_properties.py deleted file mode 100644 index d7bc3d47b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_section_properties.py +++ /dev/null @@ -1,234 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "bool", - "guid": "bool", - "name": "bool", - "section_items": "GsaQueryLayoutItemProperties", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaQueryLayoutItemProperties", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "bool | None | Unset_Type" = Unset, - guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - section_items: "GsaQueryLayoutItemProperties | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSectionProperties - a model defined in Swagger - - Parameters - ---------- - display_names: bool | None, optional - guid: bool | None, optional - name: bool | None, optional - section_items: GsaQueryLayoutItemProperties, optional - """ - self._section_items: GsaQueryLayoutItemProperties | Unset_Type = Unset - self._display_names: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if display_names is not Unset: - self.display_names = display_names - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "GsaQueryLayoutItemProperties | Unset_Type": - """Gets the section_items of this GsaQueryLayoutSectionProperties. - - Returns - ------- - GsaQueryLayoutItemProperties | Unset_Type - The section_items of this GsaQueryLayoutSectionProperties. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "GsaQueryLayoutItemProperties | Unset_Type") -> None: - """Sets the section_items of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - section_items: GsaQueryLayoutItemProperties | Unset_Type - The section_items of this GsaQueryLayoutSectionProperties. - """ - # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items - - @property - def display_names(self) -> "bool | None | Unset_Type": - """Gets the display_names of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The display_names of this GsaQueryLayoutSectionProperties. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "bool | None | Unset_Type") -> None: - """Sets the display_names of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - display_names: bool | None | Unset_Type - The display_names of this GsaQueryLayoutSectionProperties. - """ - self._display_names = display_names - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryLayoutSectionProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryLayoutSectionProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryLayoutSectionProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryLayoutSectionProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryLayoutSectionProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryLayoutSectionProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_info.py deleted file mode 100644 index 32bb313be..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "layout_sections": "list[GsaQueryLayoutSection]", - } - - attribute_map: dict[str, str] = { - "layout_sections": "layoutSections", - } - - subtype_mapping: dict[str, str] = { - "layoutSections": "GsaQueryLayoutSection", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - layout_sections: "list[GsaQueryLayoutSection]", - ) -> None: - """GsaQueryLayoutSectionsInfo - a model defined in Swagger - - Parameters - ---------- - layout_sections: list[GsaQueryLayoutSection] - """ - self._layout_sections: list[GsaQueryLayoutSection] - - self.layout_sections = layout_sections - - @property - def layout_sections(self) -> "list[GsaQueryLayoutSection]": - """Gets the layout_sections of this GsaQueryLayoutSectionsInfo. - - Returns - ------- - list[GsaQueryLayoutSection] - The layout_sections of this GsaQueryLayoutSectionsInfo. - """ - return self._layout_sections - - @layout_sections.setter - def layout_sections(self, layout_sections: "list[GsaQueryLayoutSection]") -> None: - """Sets the layout_sections of this GsaQueryLayoutSectionsInfo. - - Parameters - ---------- - layout_sections: list[GsaQueryLayoutSection] - The layout_sections of this GsaQueryLayoutSectionsInfo. - """ - # Field is not nullable - if layout_sections is None: - raise ValueError("Invalid value for 'layout_sections', must not be 'None'") - # Field is required - if layout_sections is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'layout_sections', must not be 'Unset'") - self._layout_sections = layout_sections - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_request.py deleted file mode 100644 index c2282c2f0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layout_sections_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutSectionsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "properties": "GsaQueryLayoutSectionProperties", - "filter": "GsaQueryLayoutSectionFilter", - } - - attribute_map: dict[str, str] = { - "properties": "properties", - "filter": "filter", - } - - subtype_mapping: dict[str, str] = { - "properties": "GsaQueryLayoutSectionProperties", - "filter": "GsaQueryLayoutSectionFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - properties: "GsaQueryLayoutSectionProperties", - filter: "GsaQueryLayoutSectionFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutSectionsRequest - a model defined in Swagger - - Parameters - ---------- - properties: GsaQueryLayoutSectionProperties - filter: GsaQueryLayoutSectionFilter, optional - """ - self._properties: GsaQueryLayoutSectionProperties - self._filter: GsaQueryLayoutSectionFilter | Unset_Type = Unset - - self.properties = properties - if filter is not Unset: - self.filter = filter - - @property - def properties(self) -> "GsaQueryLayoutSectionProperties": - """Gets the properties of this GsaQueryLayoutSectionsRequest. - - Returns - ------- - GsaQueryLayoutSectionProperties - The properties of this GsaQueryLayoutSectionsRequest. - """ - return self._properties - - @properties.setter - def properties(self, properties: "GsaQueryLayoutSectionProperties") -> None: - """Sets the properties of this GsaQueryLayoutSectionsRequest. - - Parameters - ---------- - properties: GsaQueryLayoutSectionProperties - The properties of this GsaQueryLayoutSectionsRequest. - """ - # Field is not nullable - if properties is None: - raise ValueError("Invalid value for 'properties', must not be 'None'") - # Field is required - if properties is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'properties', must not be 'Unset'") - self._properties = properties - - @property - def filter(self) -> "GsaQueryLayoutSectionFilter | Unset_Type": - """Gets the filter of this GsaQueryLayoutSectionsRequest. - - Returns - ------- - GsaQueryLayoutSectionFilter | Unset_Type - The filter of this GsaQueryLayoutSectionsRequest. - """ - return self._filter - - @filter.setter - def filter(self, filter: "GsaQueryLayoutSectionFilter | Unset_Type") -> None: - """Sets the filter of this GsaQueryLayoutSectionsRequest. - - Parameters - ---------- - filter: GsaQueryLayoutSectionFilter | Unset_Type - The filter of this GsaQueryLayoutSectionsRequest. - """ - # Field is not nullable - if filter is None: - raise ValueError("Invalid value for 'filter', must not be 'None'") - self._filter = filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutSectionsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_info.py deleted file mode 100644 index c41d45f34..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "layouts": "list[GsaQueryLayout]", - } - - attribute_map: dict[str, str] = { - "layouts": "layouts", - } - - subtype_mapping: dict[str, str] = { - "layouts": "GsaQueryLayout", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - layouts: "list[GsaQueryLayout]", - ) -> None: - """GsaQueryLayoutsInfo - a model defined in Swagger - - Parameters - ---------- - layouts: list[GsaQueryLayout] - """ - self._layouts: list[GsaQueryLayout] - - self.layouts = layouts - - @property - def layouts(self) -> "list[GsaQueryLayout]": - """Gets the layouts of this GsaQueryLayoutsInfo. - - Returns - ------- - list[GsaQueryLayout] - The layouts of this GsaQueryLayoutsInfo. - """ - return self._layouts - - @layouts.setter - def layouts(self, layouts: "list[GsaQueryLayout]") -> None: - """Sets the layouts of this GsaQueryLayoutsInfo. - - Parameters - ---------- - layouts: list[GsaQueryLayout] - The layouts of this GsaQueryLayoutsInfo. - """ - # Field is not nullable - if layouts is None: - raise ValueError("Invalid value for 'layouts', must not be 'None'") - # Field is required - if layouts is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'layouts', must not be 'Unset'") - self._layouts = layouts - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_request.py deleted file mode 100644 index d37b1f2a9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_layouts_request.py +++ /dev/null @@ -1,182 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryLayoutsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "properties": "GsaQueryLayoutProperties", - "filter": "GsaQueryLayoutFilter", - } - - attribute_map: dict[str, str] = { - "properties": "properties", - "filter": "filter", - } - - subtype_mapping: dict[str, str] = { - "properties": "GsaQueryLayoutProperties", - "filter": "GsaQueryLayoutFilter", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - properties: "GsaQueryLayoutProperties", - filter: "GsaQueryLayoutFilter | Unset_Type" = Unset, - ) -> None: - """GsaQueryLayoutsRequest - a model defined in Swagger - - Parameters - ---------- - properties: GsaQueryLayoutProperties - filter: GsaQueryLayoutFilter, optional - """ - self._properties: GsaQueryLayoutProperties - self._filter: GsaQueryLayoutFilter | Unset_Type = Unset - - self.properties = properties - if filter is not Unset: - self.filter = filter - - @property - def properties(self) -> "GsaQueryLayoutProperties": - """Gets the properties of this GsaQueryLayoutsRequest. - - Returns - ------- - GsaQueryLayoutProperties - The properties of this GsaQueryLayoutsRequest. - """ - return self._properties - - @properties.setter - def properties(self, properties: "GsaQueryLayoutProperties") -> None: - """Sets the properties of this GsaQueryLayoutsRequest. - - Parameters - ---------- - properties: GsaQueryLayoutProperties - The properties of this GsaQueryLayoutsRequest. - """ - # Field is not nullable - if properties is None: - raise ValueError("Invalid value for 'properties', must not be 'None'") - # Field is required - if properties is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'properties', must not be 'Unset'") - self._properties = properties - - @property - def filter(self) -> "GsaQueryLayoutFilter | Unset_Type": - """Gets the filter of this GsaQueryLayoutsRequest. - - Returns - ------- - GsaQueryLayoutFilter | Unset_Type - The filter of this GsaQueryLayoutsRequest. - """ - return self._filter - - @filter.setter - def filter(self, filter: "GsaQueryLayoutFilter | Unset_Type") -> None: - """Sets the filter of this GsaQueryLayoutsRequest. - - Parameters - ---------- - filter: GsaQueryLayoutFilter | Unset_Type - The filter of this GsaQueryLayoutsRequest. - """ - # Field is not nullable - if filter is None: - raise ValueError("Invalid value for 'filter', must not be 'None'") - self._filter = filter - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryLayoutsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity.py deleted file mode 100644 index f003245c6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimEntity(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimEntity - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - """ - self._guid: str | None | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQuerySlimEntity. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQuerySlimEntity. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimEntity. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQuerySlimEntity. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimEntity): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity_properties.py deleted file mode 100644 index 30083cf5d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_entity_properties.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimEntityProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimEntityProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - """ - self._guid: bool | None | Unset_Type = Unset - - if guid is not Unset: - self.guid = guid - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQuerySlimEntityProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQuerySlimEntityProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimEntityProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQuerySlimEntityProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimEntityProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_named_entity_filter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_named_entity_filter.py deleted file mode 100644 index 0cd6dd8bc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_slim_named_entity_filter.py +++ /dev/null @@ -1,175 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQuerySlimNamedEntityFilter(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "list[str]", - "name": "list[str]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "list[str] | None | Unset_Type" = Unset, - name: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaQuerySlimNamedEntityFilter - a model defined in Swagger - - Parameters - ---------- - guid: list[str] | None, optional - name: list[str] | None, optional - """ - self._name: list[str] | None | Unset_Type = Unset - self._guid: list[str] | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def name(self) -> "list[str] | None | Unset_Type": - """Gets the name of this GsaQuerySlimNamedEntityFilter. - If set, entity name must match any of these names. - - Returns - ------- - list[str] | None | Unset_Type - The name of this GsaQuerySlimNamedEntityFilter. - """ - return self._name - - @name.setter - def name(self, name: "list[str] | None | Unset_Type") -> None: - """Sets the name of this GsaQuerySlimNamedEntityFilter. - If set, entity name must match any of these names. - - Parameters - ---------- - name: list[str] | None | Unset_Type - The name of this GsaQuerySlimNamedEntityFilter. - """ - self._name = name - - @property - def guid(self) -> "list[str] | None | Unset_Type": - """Gets the guid of this GsaQuerySlimNamedEntityFilter. - If set, entity GUID must match any of these GUIDs. - - Returns - ------- - list[str] | None | Unset_Type - The guid of this GsaQuerySlimNamedEntityFilter. - """ - return self._guid - - @guid.setter - def guid(self, guid: "list[str] | None | Unset_Type") -> None: - """Sets the guid of this GsaQuerySlimNamedEntityFilter. - If set, entity GUID must match any of these GUIDs. - - Parameters - ---------- - guid: list[str] | None | Unset_Type - The guid of this GsaQuerySlimNamedEntityFilter. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQuerySlimNamedEntityFilter): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column.py deleted file mode 100644 index d89e470d8..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column.py +++ /dev/null @@ -1,233 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryTabularColumn(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "linked_attribute_guid": "str", - "linked_column_guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "linked_attribute_guid": "linkedAttributeGuid", - "linked_column_guid": "linkedColumnGuid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | None | Unset_Type" = Unset, - linked_attribute_guid: "str | None | Unset_Type" = Unset, - linked_column_guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryTabularColumn - a model defined in Swagger - - Parameters - ---------- - guid: str | None, optional - linked_attribute_guid: str | None, optional - linked_column_guid: str | None, optional - name: str | None, optional - """ - self._linked_attribute_guid: str | None | Unset_Type = Unset - self._linked_column_guid: str | None | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if linked_attribute_guid is not Unset: - self.linked_attribute_guid = linked_attribute_guid - if linked_column_guid is not Unset: - self.linked_column_guid = linked_column_guid - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def linked_attribute_guid(self) -> "str | None | Unset_Type": - """Gets the linked_attribute_guid of this GsaQueryTabularColumn. - This can only be populated for linked attribute type columns - - Returns - ------- - str | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumn. - """ - return self._linked_attribute_guid - - @linked_attribute_guid.setter - def linked_attribute_guid(self, linked_attribute_guid: "str | None | Unset_Type") -> None: - """Sets the linked_attribute_guid of this GsaQueryTabularColumn. - This can only be populated for linked attribute type columns - - Parameters - ---------- - linked_attribute_guid: str | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumn. - """ - self._linked_attribute_guid = linked_attribute_guid - - @property - def linked_column_guid(self) -> "str | None | Unset_Type": - """Gets the linked_column_guid of this GsaQueryTabularColumn. - This can only be populated for linked column type columns - - Returns - ------- - str | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumn. - """ - return self._linked_column_guid - - @linked_column_guid.setter - def linked_column_guid(self, linked_column_guid: "str | None | Unset_Type") -> None: - """Sets the linked_column_guid of this GsaQueryTabularColumn. - This can only be populated for linked column type columns - - Parameters - ---------- - linked_column_guid: str | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumn. - """ - self._linked_column_guid = linked_column_guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaQueryTabularColumn. - - Returns - ------- - str | None | Unset_Type - The name of this GsaQueryTabularColumn. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaQueryTabularColumn. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaQueryTabularColumn. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaQueryTabularColumn. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaQueryTabularColumn. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryTabularColumn. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaQueryTabularColumn. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryTabularColumn): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column_properties.py deleted file mode 100644 index 06db396dc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_query_tabular_column_properties.py +++ /dev/null @@ -1,231 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaQueryTabularColumnProperties(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "bool", - "linked_attribute_guid": "bool", - "linked_column_guid": "bool", - "name": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "linked_attribute_guid": "linkedAttributeGuid", - "linked_column_guid": "linkedColumnGuid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "bool | None | Unset_Type" = Unset, - linked_attribute_guid: "bool | None | Unset_Type" = Unset, - linked_column_guid: "bool | None | Unset_Type" = Unset, - name: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaQueryTabularColumnProperties - a model defined in Swagger - - Parameters - ---------- - guid: bool | None, optional - linked_attribute_guid: bool | None, optional - linked_column_guid: bool | None, optional - name: bool | None, optional - """ - self._linked_attribute_guid: bool | None | Unset_Type = Unset - self._linked_column_guid: bool | None | Unset_Type = Unset - self._name: bool | None | Unset_Type = Unset - self._guid: bool | None | Unset_Type = Unset - - if linked_attribute_guid is not Unset: - self.linked_attribute_guid = linked_attribute_guid - if linked_column_guid is not Unset: - self.linked_column_guid = linked_column_guid - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def linked_attribute_guid(self) -> "bool | None | Unset_Type": - """Gets the linked_attribute_guid of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumnProperties. - """ - return self._linked_attribute_guid - - @linked_attribute_guid.setter - def linked_attribute_guid(self, linked_attribute_guid: "bool | None | Unset_Type") -> None: - """Sets the linked_attribute_guid of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - linked_attribute_guid: bool | None | Unset_Type - The linked_attribute_guid of this GsaQueryTabularColumnProperties. - """ - self._linked_attribute_guid = linked_attribute_guid - - @property - def linked_column_guid(self) -> "bool | None | Unset_Type": - """Gets the linked_column_guid of this GsaQueryTabularColumnProperties. - This can only be populated for linked column type columns - - Returns - ------- - bool | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumnProperties. - """ - return self._linked_column_guid - - @linked_column_guid.setter - def linked_column_guid(self, linked_column_guid: "bool | None | Unset_Type") -> None: - """Sets the linked_column_guid of this GsaQueryTabularColumnProperties. - This can only be populated for linked column type columns - - Parameters - ---------- - linked_column_guid: bool | None | Unset_Type - The linked_column_guid of this GsaQueryTabularColumnProperties. - """ - self._linked_column_guid = linked_column_guid - - @property - def name(self) -> "bool | None | Unset_Type": - """Gets the name of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The name of this GsaQueryTabularColumnProperties. - """ - return self._name - - @name.setter - def name(self, name: "bool | None | Unset_Type") -> None: - """Sets the name of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - name: bool | None | Unset_Type - The name of this GsaQueryTabularColumnProperties. - """ - self._name = name - - @property - def guid(self) -> "bool | None | Unset_Type": - """Gets the guid of this GsaQueryTabularColumnProperties. - - Returns - ------- - bool | None | Unset_Type - The guid of this GsaQueryTabularColumnProperties. - """ - return self._guid - - @guid.setter - def guid(self, guid: "bool | None | Unset_Type") -> None: - """Sets the guid of this GsaQueryTabularColumnProperties. - - Parameters - ---------- - guid: bool | None | Unset_Type - The guid of this GsaQueryTabularColumnProperties. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaQueryTabularColumnProperties): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_attribute.py index 563a5f155..d1a5b8a11 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_attribute.py @@ -69,7 +69,6 @@ class GsaRangeAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -85,7 +84,6 @@ class GsaRangeAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -109,7 +107,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType" = GsaAttributeType.RANGE, @@ -127,7 +124,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -142,7 +138,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_chart_data.py deleted file mode 100644 index a0c66b6cd..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_chart_data.py +++ /dev/null @@ -1,229 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data_type import GsaChartDataType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRangeChartData(GsaChartData): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", - "estimated": "bool", - "high_value": "float", - "low_value": "float", - "record_version_guid": "str", - } - - attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", - "estimated": "estimated", - "high_value": "highValue", - "low_value": "lowValue", - "record_version_guid": "recordVersionGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - type: "GsaChartDataType" = GsaChartDataType.RANGE, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, - estimated: "bool | Unset_Type" = Unset, - high_value: "float | Unset_Type" = Unset, - low_value: "float | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaRangeChartData - a model defined in Swagger - - Parameters - ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional - estimated: bool, optional - high_value: float, optional - low_value: float, optional - record_version_guid: str, optional - """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._low_value: float | Unset_Type = Unset - self._high_value: float | Unset_Type = Unset - self._estimated: bool | Unset_Type = Unset - - if low_value is not Unset: - self.low_value = low_value - if high_value is not Unset: - self.high_value = high_value - if estimated is not Unset: - self.estimated = estimated - - @property - def low_value(self) -> "float | Unset_Type": - """Gets the low_value of this GsaRangeChartData. - - Returns - ------- - float | Unset_Type - The low_value of this GsaRangeChartData. - """ - return self._low_value - - @low_value.setter - def low_value(self, low_value: "float | Unset_Type") -> None: - """Sets the low_value of this GsaRangeChartData. - - Parameters - ---------- - low_value: float | Unset_Type - The low_value of this GsaRangeChartData. - """ - # Field is not nullable - if low_value is None: - raise ValueError("Invalid value for 'low_value', must not be 'None'") - self._low_value = low_value - - @property - def high_value(self) -> "float | Unset_Type": - """Gets the high_value of this GsaRangeChartData. - - Returns - ------- - float | Unset_Type - The high_value of this GsaRangeChartData. - """ - return self._high_value - - @high_value.setter - def high_value(self, high_value: "float | Unset_Type") -> None: - """Sets the high_value of this GsaRangeChartData. - - Parameters - ---------- - high_value: float | Unset_Type - The high_value of this GsaRangeChartData. - """ - # Field is not nullable - if high_value is None: - raise ValueError("Invalid value for 'high_value', must not be 'None'") - self._high_value = high_value - - @property - def estimated(self) -> "bool | Unset_Type": - """Gets the estimated of this GsaRangeChartData. - - Returns - ------- - bool | Unset_Type - The estimated of this GsaRangeChartData. - """ - return self._estimated - - @estimated.setter - def estimated(self, estimated: "bool | Unset_Type") -> None: - """Sets the estimated of this GsaRangeChartData. - - Parameters - ---------- - estimated: bool | Unset_Type - The estimated of this GsaRangeChartData. - """ - # Field is not nullable - if estimated is None: - raise ValueError("Invalid value for 'estimated', must not be 'None'") - self._estimated = estimated - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRangeChartData): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_datum.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_datum.py index 15e52d192..e386a6c95 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_datum.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_datum.py @@ -68,10 +68,12 @@ class GsaRangeDatum(GsaApplicableDatum): swagger_types: dict[str, str] = { "datum_type": "GsaDatumType", "estimated": "bool", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", "not_applicable": "str", - "high_endpoint": "GsaRangeEndpoint", "high_value_significant_figures_info": "GsaSignificantFiguresInfo", - "low_endpoint": "GsaRangeEndpoint", "low_value_significant_figures_info": "GsaSignificantFiguresInfo", "unit": "GsaSlimUnit", } @@ -79,17 +81,17 @@ class GsaRangeDatum(GsaApplicableDatum): attribute_map: dict[str, str] = { "datum_type": "datumType", "estimated": "estimated", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", "not_applicable": "notApplicable", - "high_endpoint": "highEndpoint", "high_value_significant_figures_info": "highValueSignificantFiguresInfo", - "low_endpoint": "lowEndpoint", "low_value_significant_figures_info": "lowValueSignificantFiguresInfo", "unit": "unit", } subtype_mapping: dict[str, str] = { - "highEndpoint": "GsaRangeEndpoint", - "lowEndpoint": "GsaRangeEndpoint", "lowValueSignificantFiguresInfo": "GsaSignificantFiguresInfo", "highValueSignificantFiguresInfo": "GsaSignificantFiguresInfo", "unit": "GsaSlimUnit", @@ -102,10 +104,12 @@ def __init__( *, datum_type: "GsaDatumType" = GsaDatumType.RANGE, estimated: "bool", + high_value: "float", + high_value_is_inclusive: "bool", + low_value: "float", + low_value_is_inclusive: "bool", not_applicable: "str | None" = "applicable", - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, high_value_significant_figures_info: "GsaSignificantFiguresInfo | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, low_value_significant_figures_info: "GsaSignificantFiguresInfo | Unset_Type" = Unset, unit: "GsaSlimUnit | Unset_Type" = Unset, ) -> None: @@ -115,25 +119,29 @@ def __init__( ---------- datum_type: GsaDatumType estimated: bool + high_value: float + high_value_is_inclusive: bool + low_value: float + low_value_is_inclusive: bool not_applicable: str | None - high_endpoint: GsaRangeEndpoint, optional high_value_significant_figures_info: GsaSignificantFiguresInfo, optional - low_endpoint: GsaRangeEndpoint, optional low_value_significant_figures_info: GsaSignificantFiguresInfo, optional unit: GsaSlimUnit, optional """ super().__init__(datum_type=datum_type, not_applicable=not_applicable) - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._low_value: float + self._high_value: float + self._low_value_is_inclusive: bool + self._high_value_is_inclusive: bool self._low_value_significant_figures_info: GsaSignificantFiguresInfo | Unset_Type = Unset self._high_value_significant_figures_info: GsaSignificantFiguresInfo | Unset_Type = Unset self._estimated: bool self._unit: GsaSlimUnit | Unset_Type = Unset - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint + self.low_value = low_value + self.high_value = high_value + self.low_value_is_inclusive = low_value_is_inclusive + self.high_value_is_inclusive = high_value_is_inclusive if low_value_significant_figures_info is not Unset: self.low_value_significant_figures_info = low_value_significant_figures_info if high_value_significant_figures_info is not Unset: @@ -143,54 +151,116 @@ def __init__( self.unit = unit @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaRangeDatum. + def low_value(self) -> "float": + """Gets the low_value of this GsaRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaRangeDatum. + float + The low_value of this GsaRangeDatum. """ - return self._high_endpoint + return self._low_value - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaRangeDatum. + @low_value.setter + def low_value(self, low_value: "float") -> None: + """Sets the low_value of this GsaRangeDatum. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaRangeDatum. + low_value: float + The low_value of this GsaRangeDatum. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if low_value is None: + raise ValueError("Invalid value for 'low_value', must not be 'None'") + # Field is required + if low_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value', must not be 'Unset'") + self._low_value = low_value + + @property + def high_value(self) -> "float": + """Gets the high_value of this GsaRangeDatum. + + Returns + ------- + float + The high_value of this GsaRangeDatum. + """ + return self._high_value + + @high_value.setter + def high_value(self, high_value: "float") -> None: + """Sets the high_value of this GsaRangeDatum. + + Parameters + ---------- + high_value: float + The high_value of this GsaRangeDatum. + """ + # Field is not nullable + if high_value is None: + raise ValueError("Invalid value for 'high_value', must not be 'None'") + # Field is required + if high_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value', must not be 'Unset'") + self._high_value = high_value + + @property + def low_value_is_inclusive(self) -> "bool": + """Gets the low_value_is_inclusive of this GsaRangeDatum. + + Returns + ------- + bool + The low_value_is_inclusive of this GsaRangeDatum. + """ + return self._low_value_is_inclusive + + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool") -> None: + """Sets the low_value_is_inclusive of this GsaRangeDatum. + + Parameters + ---------- + low_value_is_inclusive: bool + The low_value_is_inclusive of this GsaRangeDatum. + """ + # Field is not nullable + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + # Field is required + if low_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'Unset'") + self._low_value_is_inclusive = low_value_is_inclusive @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaRangeDatum. + def high_value_is_inclusive(self) -> "bool": + """Gets the high_value_is_inclusive of this GsaRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaRangeDatum. + bool + The high_value_is_inclusive of this GsaRangeDatum. """ - return self._low_endpoint + return self._high_value_is_inclusive - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaRangeDatum. + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool") -> None: + """Sets the high_value_is_inclusive of this GsaRangeDatum. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaRangeDatum. + high_value_is_inclusive: bool + The high_value_is_inclusive of this GsaRangeDatum. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + # Field is required + if high_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'Unset'") + self._high_value_is_inclusive = high_value_is_inclusive @property def low_value_significant_figures_info(self) -> "GsaSignificantFiguresInfo | Unset_Type": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_endpoint.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_endpoint.py deleted file mode 100644 index 65982c520..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_range_endpoint.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRangeEndpoint(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "inclusiveness": "GsaInclusiveness", - "value": "float", - } - - attribute_map: dict[str, str] = { - "inclusiveness": "inclusiveness", - "value": "value", - } - - subtype_mapping: dict[str, str] = { - "inclusiveness": "GsaInclusiveness", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - inclusiveness: "GsaInclusiveness", - value: "float", - ) -> None: - """GsaRangeEndpoint - a model defined in Swagger - - Parameters - ---------- - inclusiveness: GsaInclusiveness - value: float - """ - self._value: float - self._inclusiveness: GsaInclusiveness - - self.value = value - self.inclusiveness = inclusiveness - - @property - def value(self) -> "float": - """Gets the value of this GsaRangeEndpoint. - - Returns - ------- - float - The value of this GsaRangeEndpoint. - """ - return self._value - - @value.setter - def value(self, value: "float") -> None: - """Sets the value of this GsaRangeEndpoint. - - Parameters - ---------- - value: float - The value of this GsaRangeEndpoint. - """ - # Field is not nullable - if value is None: - raise ValueError("Invalid value for 'value', must not be 'None'") - # Field is required - if value is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'value', must not be 'Unset'") - self._value = value - - @property - def inclusiveness(self) -> "GsaInclusiveness": - """Gets the inclusiveness of this GsaRangeEndpoint. - - Returns - ------- - GsaInclusiveness - The inclusiveness of this GsaRangeEndpoint. - """ - return self._inclusiveness - - @inclusiveness.setter - def inclusiveness(self, inclusiveness: "GsaInclusiveness") -> None: - """Sets the inclusiveness of this GsaRangeEndpoint. - - Parameters - ---------- - inclusiveness: GsaInclusiveness - The inclusiveness of this GsaRangeEndpoint. - """ - # Field is not nullable - if inclusiveness is None: - raise ValueError("Invalid value for 'inclusiveness', must not be 'None'") - # Field is required - if inclusiveness is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'inclusiveness', must not be 'Unset'") - self._inclusiveness = inclusiveness - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRangeEndpoint): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_and_attribute_selection_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_and_attribute_selection_type.py deleted file mode 100644 index 32ff25b2e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_and_attribute_selection_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRecordAndAttributeSelectionType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - PROFILE = "Profile" - ALLATTRIBUTES = "AllAttributes" - ALLATTRIBUTESANDRECORDS = "AllAttributesAndRecords" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_user_capabilities.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_capabilities.py similarity index 86% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_user_capabilities.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_capabilities.py index a435ddb1b..64de483c7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_user_capabilities.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_capabilities.py @@ -42,7 +42,7 @@ from . import * -class GsaRecordUserCapabilities(ModelBase): +class GsaRecordCapabilities(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -92,7 +92,7 @@ def __init__( can_withdraw: "bool", can_write: "bool", ) -> None: - """GsaRecordUserCapabilities - a model defined in Swagger + """GsaRecordCapabilities - a model defined in Swagger Parameters ---------- @@ -119,25 +119,25 @@ def __init__( @property def can_write(self) -> "bool": - """Gets the can_write of this GsaRecordUserCapabilities. + """Gets the can_write of this GsaRecordCapabilities. True if the current user has write permission for this record version, and is in write mode. Write permission is required to edit record properties, and to perform version control actions. Returns ------- bool - The can_write of this GsaRecordUserCapabilities. + The can_write of this GsaRecordCapabilities. """ return self._can_write @can_write.setter def can_write(self, can_write: "bool") -> None: - """Sets the can_write of this GsaRecordUserCapabilities. + """Sets the can_write of this GsaRecordCapabilities. True if the current user has write permission for this record version, and is in write mode. Write permission is required to edit record properties, and to perform version control actions. Parameters ---------- can_write: bool - The can_write of this GsaRecordUserCapabilities. + The can_write of this GsaRecordCapabilities. """ # Field is not nullable if can_write is None: @@ -149,25 +149,25 @@ def can_write(self, can_write: "bool") -> None: @property def can_modify(self) -> "bool": - """Gets the can_modify of this GsaRecordUserCapabilities. + """Gets the can_modify of this GsaRecordCapabilities. True if the current user can modify this record version, e.g. edit record properties. The user needs write permission, and if the table is version controlled, the record must be unreleased. Returns ------- bool - The can_modify of this GsaRecordUserCapabilities. + The can_modify of this GsaRecordCapabilities. """ return self._can_modify @can_modify.setter def can_modify(self, can_modify: "bool") -> None: - """Sets the can_modify of this GsaRecordUserCapabilities. + """Sets the can_modify of this GsaRecordCapabilities. True if the current user can modify this record version, e.g. edit record properties. The user needs write permission, and if the table is version controlled, the record must be unreleased. Parameters ---------- can_modify: bool - The can_modify of this GsaRecordUserCapabilities. + The can_modify of this GsaRecordCapabilities. """ # Field is not nullable if can_modify is None: @@ -179,25 +179,25 @@ def can_modify(self, can_modify: "bool") -> None: @property def can_release(self) -> "bool": - """Gets the can_release of this GsaRecordUserCapabilities. + """Gets the can_release of this GsaRecordCapabilities. True if the current user can release this record version. Returns ------- bool - The can_release of this GsaRecordUserCapabilities. + The can_release of this GsaRecordCapabilities. """ return self._can_release @can_release.setter def can_release(self, can_release: "bool") -> None: - """Sets the can_release of this GsaRecordUserCapabilities. + """Sets the can_release of this GsaRecordCapabilities. True if the current user can release this record version. Parameters ---------- can_release: bool - The can_release of this GsaRecordUserCapabilities. + The can_release of this GsaRecordCapabilities. """ # Field is not nullable if can_release is None: @@ -209,25 +209,25 @@ def can_release(self, can_release: "bool") -> None: @property def can_get_modifiable_version(self) -> "bool": - """Gets the can_get_modifiable_version of this GsaRecordUserCapabilities. + """Gets the can_get_modifiable_version of this GsaRecordCapabilities. True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists). Returns ------- bool - The can_get_modifiable_version of this GsaRecordUserCapabilities. + The can_get_modifiable_version of this GsaRecordCapabilities. """ return self._can_get_modifiable_version @can_get_modifiable_version.setter def can_get_modifiable_version(self, can_get_modifiable_version: "bool") -> None: - """Sets the can_get_modifiable_version of this GsaRecordUserCapabilities. + """Sets the can_get_modifiable_version of this GsaRecordCapabilities. True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists). Parameters ---------- can_get_modifiable_version: bool - The can_get_modifiable_version of this GsaRecordUserCapabilities. + The can_get_modifiable_version of this GsaRecordCapabilities. """ # Field is not nullable if can_get_modifiable_version is None: @@ -239,25 +239,25 @@ def can_get_modifiable_version(self, can_get_modifiable_version: "bool") -> None @property def can_withdraw(self) -> "bool": - """Gets the can_withdraw of this GsaRecordUserCapabilities. + """Gets the can_withdraw of this GsaRecordCapabilities. True if the current user can withdraw this record version. Returns ------- bool - The can_withdraw of this GsaRecordUserCapabilities. + The can_withdraw of this GsaRecordCapabilities. """ return self._can_withdraw @can_withdraw.setter def can_withdraw(self, can_withdraw: "bool") -> None: - """Sets the can_withdraw of this GsaRecordUserCapabilities. + """Sets the can_withdraw of this GsaRecordCapabilities. True if the current user can withdraw this record version. Parameters ---------- can_withdraw: bool - The can_withdraw of this GsaRecordUserCapabilities. + The can_withdraw of this GsaRecordCapabilities. """ # Field is not nullable if can_withdraw is None: @@ -269,25 +269,25 @@ def can_withdraw(self, can_withdraw: "bool") -> None: @property def can_delete(self) -> "bool": - """Gets the can_delete of this GsaRecordUserCapabilities. + """Gets the can_delete of this GsaRecordCapabilities. True if the current user can delete this record version. Returns ------- bool - The can_delete of this GsaRecordUserCapabilities. + The can_delete of this GsaRecordCapabilities. """ return self._can_delete @can_delete.setter def can_delete(self, can_delete: "bool") -> None: - """Sets the can_delete of this GsaRecordUserCapabilities. + """Sets the can_delete of this GsaRecordCapabilities. True if the current user can delete this record version. Parameters ---------- can_delete: bool - The can_delete of this GsaRecordUserCapabilities. + The can_delete of this GsaRecordCapabilities. """ # Field is not nullable if can_delete is None: @@ -319,7 +319,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordUserCapabilities): + if not isinstance(other, GsaRecordCapabilities): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_copy_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_copy_exception.py index df51cd470..172e8dec5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_copy_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_copy_exception.py @@ -61,7 +61,7 @@ class GsaRecordHistoryCopyException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaRecordHistoryCopyException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaErrorDetail", } @@ -82,7 +82,7 @@ class GsaRecordHistoryCopyException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaRecordHistoryCopyException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryCopyException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaRecordHistoryCopyException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryCopyException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_move_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_move_exception.py index 3a8bfa5cb..bac8cdc38 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_move_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_history_move_exception.py @@ -61,7 +61,7 @@ class GsaRecordHistoryMoveException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaRecordHistoryMoveException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaErrorDetail", } @@ -82,7 +82,7 @@ class GsaRecordHistoryMoveException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaRecordHistoryMoveException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryMoveException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaRecordHistoryMoveException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaRecordHistoryMoveException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link.py deleted file mode 100644 index 140f3db75..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link.py +++ /dev/null @@ -1,189 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "include_indirect_links": "bool", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "include_indirect_links": "includeIndirectLinks", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - include_indirect_links: "bool", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.RECORDLINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - include_indirect_links: bool - link_info: GsaLinkInfo - name: str - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._include_indirect_links: bool - - self.include_indirect_links = include_indirect_links - - @property - def include_indirect_links(self) -> "bool": - """Gets the include_indirect_links of this GsaRecordLink. - - Returns - ------- - bool - The include_indirect_links of this GsaRecordLink. - """ - return self._include_indirect_links - - @include_indirect_links.setter - def include_indirect_links(self, include_indirect_links: "bool") -> None: - """Sets the include_indirect_links of this GsaRecordLink. - - Parameters - ---------- - include_indirect_links: bool - The include_indirect_links of this GsaRecordLink. - """ - # Field is not nullable - if include_indirect_links is None: - raise ValueError("Invalid value for 'include_indirect_links', must not be 'None'") - # Field is required - if include_indirect_links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'include_indirect_links', must not be 'Unset'") - self._include_indirect_links = include_indirect_links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_base.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_base.py deleted file mode 100644 index 8e6d71956..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_base.py +++ /dev/null @@ -1,292 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkBase(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroupType": "GsaRecordLinkGroupType", - } - - discriminator_value_class_map = { - "static".lower(): "#/components/schemas/GsaStaticRecordLink", - "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLink", - } - - discriminator: Optional[str] = "recordLinkGroupType" - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType", - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkBase - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - """ - self._record_link_group_type: GsaRecordLinkGroupType - self._source_record_history_guid: str - self._target_record_history_guid: str - self._notes: str | None | Unset_Type = Unset - self._guid: str - - self.record_link_group_type = record_link_group_type - self.source_record_history_guid = source_record_history_guid - self.target_record_history_guid = target_record_history_guid - if notes is not Unset: - self.notes = notes - self.guid = guid - - @property - def record_link_group_type(self) -> "GsaRecordLinkGroupType": - """Gets the record_link_group_type of this GsaRecordLinkBase. - - Returns - ------- - GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkBase. - """ - return self._record_link_group_type - - @record_link_group_type.setter - def record_link_group_type(self, record_link_group_type: "GsaRecordLinkGroupType") -> None: - """Sets the record_link_group_type of this GsaRecordLinkBase. - - Parameters - ---------- - record_link_group_type: GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkBase. - """ - # Field is not nullable - if record_link_group_type is None: - raise ValueError("Invalid value for 'record_link_group_type', must not be 'None'") - # Field is required - if record_link_group_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_type', must not be 'Unset'") - self._record_link_group_type = record_link_group_type - - @property - def source_record_history_guid(self) -> "str": - """Gets the source_record_history_guid of this GsaRecordLinkBase. - - Returns - ------- - str - The source_record_history_guid of this GsaRecordLinkBase. - """ - return self._source_record_history_guid - - @source_record_history_guid.setter - def source_record_history_guid(self, source_record_history_guid: "str") -> None: - """Sets the source_record_history_guid of this GsaRecordLinkBase. - - Parameters - ---------- - source_record_history_guid: str - The source_record_history_guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if source_record_history_guid is None: - raise ValueError("Invalid value for 'source_record_history_guid', must not be 'None'") - # Field is required - if source_record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_record_history_guid', must not be 'Unset'") - self._source_record_history_guid = source_record_history_guid - - @property - def target_record_history_guid(self) -> "str": - """Gets the target_record_history_guid of this GsaRecordLinkBase. - - Returns - ------- - str - The target_record_history_guid of this GsaRecordLinkBase. - """ - return self._target_record_history_guid - - @target_record_history_guid.setter - def target_record_history_guid(self, target_record_history_guid: "str") -> None: - """Sets the target_record_history_guid of this GsaRecordLinkBase. - - Parameters - ---------- - target_record_history_guid: str - The target_record_history_guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if target_record_history_guid is None: - raise ValueError("Invalid value for 'target_record_history_guid', must not be 'None'") - # Field is required - if target_record_history_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_record_history_guid', must not be 'Unset'") - self._target_record_history_guid = target_record_history_guid - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaRecordLinkBase. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaRecordLinkBase. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaRecordLinkBase. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaRecordLinkBase. - """ - self._notes = notes - - @property - def guid(self) -> "str": - """Gets the guid of this GsaRecordLinkBase. - - Returns - ------- - str - The guid of this GsaRecordLinkBase. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaRecordLinkBase. - - Parameters - ---------- - guid: str - The guid of this GsaRecordLinkBase. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkBase): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_create_put_layout_item.py deleted file mode 100644 index 149781a1a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_create_put_layout_item.py +++ /dev/null @@ -1,193 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "type": "GsaPutType", - "forwards": "bool", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "type": "type", - "forwards": "forwards", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.RECORDLINK, - link_group_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - forwards: "bool | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - type: GsaPutType - forwards: bool | None, optional - """ - super().__init__(item_type=item_type, type=type) - self._forwards: bool | None | Unset_Type = Unset - self._link_group_guid: str - - if forwards is not Unset: - self.forwards = forwards - self.link_group_guid = link_group_guid - - @property - def forwards(self) -> "bool | None | Unset_Type": - """Gets the forwards of this GsaRecordLinkCreatePutLayoutItem. - - Returns - ------- - bool | None | Unset_Type - The forwards of this GsaRecordLinkCreatePutLayoutItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | None | Unset_Type") -> None: - """Sets the forwards of this GsaRecordLinkCreatePutLayoutItem. - - Parameters - ---------- - forwards: bool | None | Unset_Type - The forwards of this GsaRecordLinkCreatePutLayoutItem. - """ - self._forwards = forwards - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaRecordLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group.py index e6e5e3c45..744d89a78 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group.py @@ -91,7 +91,7 @@ class GsaRecordLinkGroup(ModelBase): discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLinkGroup", } @@ -275,7 +275,6 @@ def reverse_display_names( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -287,7 +286,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_creation_exception.py deleted file mode 100644 index 349e4ded9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_creation_exception.py +++ /dev/null @@ -1,235 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaRecordLinkGroupErrorDetail]", - "message": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - "name": "name", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkGroupCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaRecordLinkGroupErrorDetail] | None, optional - message: str | None, optional - name: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str | None | Unset_Type = Unset - self._errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if name is not Unset: - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaRecordLinkGroupCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaRecordLinkGroupCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaRecordLinkGroupCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaRecordLinkGroupCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaRecordLinkGroupCreationException. - - Returns - ------- - str | None | Unset_Type - The name of this GsaRecordLinkGroupCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaRecordLinkGroupCreationException. - """ - self._name = name - - @property - def errors(self) -> "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaRecordLinkGroupCreationException. - - Returns - ------- - list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaRecordLinkGroupCreationException. - - Parameters - ---------- - errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_detail.py deleted file mode 100644 index 8bd247599..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_detail.py +++ /dev/null @@ -1,205 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaRecordLinkGroupErrorReason", - } - - discriminator_value_class_map = { - "forbidOrphans".lower(): "#/components/schemas/GsaForbidOrphansRecordLinkGroupErrorDetail", - "manyToManyForbidOrphans".lower(): "#/components/schemas/GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", - "nameAlreadyExistsAsReverse".lower(): "#/components/schemas/GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityRecordLinkGroupErrorDetail", - "nameSameAsReverseName".lower(): "#/components/schemas/GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "noSuchTargetTable".lower(): "#/components/schemas/GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "referentialIntegrityModel".lower(): "#/components/schemas/GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "reverseNameAlreadyExists".lower(): "#/components/schemas/GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "reverseNameAlreadyExistsAsName".lower(): "#/components/schemas/GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "reverseNameNotProvided".lower(): "#/components/schemas/GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", - "smartAttributes".lower(): "#/components/schemas/GsaSmartAttributesRecordLinkGroupErrorDetail", - "swapNameAndReverseNameCircular".lower(): "#/components/schemas/GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason", - ) -> None: - """GsaRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - self._message: str - self._reason: GsaRecordLinkGroupErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaRecordLinkGroupErrorDetail. - - Returns - ------- - str - The message of this GsaRecordLinkGroupErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaRecordLinkGroupErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaRecordLinkGroupErrorReason": - """Gets the reason of this GsaRecordLinkGroupErrorDetail. - - Returns - ------- - GsaRecordLinkGroupErrorReason - The reason of this GsaRecordLinkGroupErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaRecordLinkGroupErrorReason") -> None: - """Sets the reason of this GsaRecordLinkGroupErrorDetail. - - Parameters - ---------- - reason: GsaRecordLinkGroupErrorReason - The reason of this GsaRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_reason.py deleted file mode 100644 index 75c454693..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_error_reason.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRecordLinkGroupErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - FORBIDORPHANS = "forbidOrphans" - MANYTOMANYFORBIDORPHANS = "manyToManyForbidOrphans" - NAMEALREADYEXISTSASREVERSE = "nameAlreadyExistsAsReverse" - NAMEDENTITY = "namedEntity" - NAMESAMEASREVERSENAME = "nameSameAsReverseName" - NOSUCHTARGETTABLE = "noSuchTargetTable" - REFERENTIALINTEGRITYMODEL = "referentialIntegrityModel" - REVERSENAMEALREADYEXISTS = "reverseNameAlreadyExists" - REVERSENAMEALREADYEXISTSASNAME = "reverseNameAlreadyExistsAsName" - REVERSENAMENOTPROVIDED = "reverseNameNotProvided" - SMARTATTRIBUTES = "smartAttributes" - SWAPNAMEANDREVERSENAMECIRCULAR = "swapNameAndReverseNameCircular" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_type.py index ea1352161..561b98a56 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_type.py @@ -43,5 +43,5 @@ class GsaRecordLinkGroupType(Enum): Allowed Enum values """ STATIC = "static" - SMART = "smart" + DYNAMIC = "dynamic" CROSSDATABASE = "crossDatabase" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_update_exception.py deleted file mode 100644 index bf1d71630..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_group_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkGroupUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_link_group_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaRecordLinkGroupErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "record_link_group_guid": "recordLinkGroupGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaRecordLinkGroupErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_link_group_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordLinkGroupUpdateException - a model defined in Swagger - - Parameters - ---------- - record_link_group_guid: str - code: GsaErrorCode, optional - errors: list[GsaRecordLinkGroupErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._record_link_group_guid: str - self._errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.record_link_group_guid = record_link_group_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaRecordLinkGroupUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaRecordLinkGroupUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaRecordLinkGroupUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def record_link_group_guid(self) -> "str": - """Gets the record_link_group_guid of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - str - The record_link_group_guid of this GsaRecordLinkGroupUpdateException. - """ - return self._record_link_group_guid - - @record_link_group_guid.setter - def record_link_group_guid(self, record_link_group_guid: "str") -> None: - """Sets the record_link_group_guid of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - record_link_group_guid: str - The record_link_group_guid of this GsaRecordLinkGroupUpdateException. - """ - # Field is not nullable - if record_link_group_guid is None: - raise ValueError("Invalid value for 'record_link_group_guid', must not be 'None'") - # Field is required - if record_link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_guid', must not be 'Unset'") - self._record_link_group_guid = record_link_group_guid - - @property - def errors(self) -> "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaRecordLinkGroupUpdateException. - - Returns - ------- - list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaRecordLinkGroupUpdateException. - - Parameters - ---------- - errors: list[GsaRecordLinkGroupErrorDetail] | None | Unset_Type - The errors of this GsaRecordLinkGroupUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkGroupUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_groups_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_groups_info.py index 609c782c4..d9050ad57 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_groups_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_groups_info.py @@ -61,7 +61,7 @@ class GsaRecordLinkGroupsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "record_link_groups": "list[GsaRecordLinkGroup]", + "record_link_groups": "list[GsaSlimRecordLinkGroup]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaRecordLinkGroupsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "recordLinkGroups": "GsaRecordLinkGroup", + "recordLinkGroups": "GsaSlimRecordLinkGroup", } discriminator: Optional[str] = None @@ -77,39 +77,39 @@ class GsaRecordLinkGroupsInfo(ModelBase): def __init__( self, *, - record_link_groups: "list[GsaRecordLinkGroup] | None | Unset_Type" = Unset, + record_link_groups: "list[GsaSlimRecordLinkGroup] | None | Unset_Type" = Unset, ) -> None: """GsaRecordLinkGroupsInfo - a model defined in Swagger Parameters ---------- - record_link_groups: list[GsaRecordLinkGroup] | None, optional + record_link_groups: list[GsaSlimRecordLinkGroup] | None, optional """ - self._record_link_groups: list[GsaRecordLinkGroup] | None | Unset_Type = Unset + self._record_link_groups: list[GsaSlimRecordLinkGroup] | None | Unset_Type = Unset if record_link_groups is not Unset: self.record_link_groups = record_link_groups @property - def record_link_groups(self) -> "list[GsaRecordLinkGroup] | None | Unset_Type": + def record_link_groups(self) -> "list[GsaSlimRecordLinkGroup] | None | Unset_Type": """Gets the record_link_groups of this GsaRecordLinkGroupsInfo. Returns ------- - list[GsaRecordLinkGroup] | None | Unset_Type + list[GsaSlimRecordLinkGroup] | None | Unset_Type The record_link_groups of this GsaRecordLinkGroupsInfo. """ return self._record_link_groups @record_link_groups.setter def record_link_groups( - self, record_link_groups: "list[GsaRecordLinkGroup] | None | Unset_Type" + self, record_link_groups: "list[GsaSlimRecordLinkGroup] | None | Unset_Type" ) -> None: """Sets the record_link_groups of this GsaRecordLinkGroupsInfo. Parameters ---------- - record_link_groups: list[GsaRecordLinkGroup] | None | Unset_Type + record_link_groups: list[GsaSlimRecordLinkGroup] | None | Unset_Type The record_link_groups of this GsaRecordLinkGroupsInfo. """ self._record_link_groups = record_link_groups diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_result.py deleted file mode 100644 index 86f10fe34..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_result.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - } - - attribute_map: dict[str, str] = { - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroupType": "GsaRecordLinkGroupType", - "linkedRecord": "GsaSlimRecordVersion", - } - - discriminator_value_class_map = { - "static".lower(): "#/components/schemas/GsaStaticRecordLinkResult", - "smart".lower(): "#/components/schemas/GsaSmartRecordLinkResult", - "crossDatabase".lower(): "#/components/schemas/GsaCrossDatabaseRecordLinkResult", - } - - discriminator: Optional[str] = "recordLinkGroupType" - - def __init__( - self, - *, - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType", - ) -> None: - """GsaRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - """ - self._record_link_group_type: GsaRecordLinkGroupType - self._linked_record: GsaSlimRecordVersion - - self.record_link_group_type = record_link_group_type - self.linked_record = linked_record - - @property - def record_link_group_type(self) -> "GsaRecordLinkGroupType": - """Gets the record_link_group_type of this GsaRecordLinkResult. - - Returns - ------- - GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkResult. - """ - return self._record_link_group_type - - @record_link_group_type.setter - def record_link_group_type(self, record_link_group_type: "GsaRecordLinkGroupType") -> None: - """Sets the record_link_group_type of this GsaRecordLinkResult. - - Parameters - ---------- - record_link_group_type: GsaRecordLinkGroupType - The record_link_group_type of this GsaRecordLinkResult. - """ - # Field is not nullable - if record_link_group_type is None: - raise ValueError("Invalid value for 'record_link_group_type', must not be 'None'") - # Field is required - if record_link_group_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group_type', must not be 'Unset'") - self._record_link_group_type = record_link_group_type - - @property - def linked_record(self) -> "GsaSlimRecordVersion": - """Gets the linked_record of this GsaRecordLinkResult. - - Returns - ------- - GsaSlimRecordVersion - The linked_record of this GsaRecordLinkResult. - """ - return self._linked_record - - @linked_record.setter - def linked_record(self, linked_record: "GsaSlimRecordVersion") -> None: - """Sets the linked_record of this GsaRecordLinkResult. - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - The linked_record of this GsaRecordLinkResult. - """ - # Field is not nullable - if linked_record is None: - raise ValueError("Invalid value for 'linked_record', must not be 'None'") - # Field is required - if linked_record is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'linked_record', must not be 'Unset'") - self._linked_record = linked_record - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_results.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_results.py deleted file mode 100644 index 1c8b1ee5c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_link_results.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordLinkResults(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_link_group": "GsaSlimRecordLinkGroup", - "results": "list[GsaRecordLinkResult]", - } - - attribute_map: dict[str, str] = { - "record_link_group": "recordLinkGroup", - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroup": "GsaSlimRecordLinkGroup", - "results": "GsaRecordLinkResult", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_link_group: "GsaSlimRecordLinkGroup", - results: "list[GsaRecordLinkResult]", - ) -> None: - """GsaRecordLinkResults - a model defined in Swagger - - Parameters - ---------- - record_link_group: GsaSlimRecordLinkGroup - results: list[GsaRecordLinkResult] - """ - self._record_link_group: GsaSlimRecordLinkGroup - self._results: list[GsaRecordLinkResult] - - self.record_link_group = record_link_group - self.results = results - - @property - def record_link_group(self) -> "GsaSlimRecordLinkGroup": - """Gets the record_link_group of this GsaRecordLinkResults. - - Returns - ------- - GsaSlimRecordLinkGroup - The record_link_group of this GsaRecordLinkResults. - """ - return self._record_link_group - - @record_link_group.setter - def record_link_group(self, record_link_group: "GsaSlimRecordLinkGroup") -> None: - """Sets the record_link_group of this GsaRecordLinkResults. - - Parameters - ---------- - record_link_group: GsaSlimRecordLinkGroup - The record_link_group of this GsaRecordLinkResults. - """ - # Field is not nullable - if record_link_group is None: - raise ValueError("Invalid value for 'record_link_group', must not be 'None'") - # Field is required - if record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group', must not be 'Unset'") - self._record_link_group = record_link_group - - @property - def results(self) -> "list[GsaRecordLinkResult]": - """Gets the results of this GsaRecordLinkResults. - - Returns - ------- - list[GsaRecordLinkResult] - The results of this GsaRecordLinkResults. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaRecordLinkResult]") -> None: - """Sets the results of this GsaRecordLinkResults. - - Parameters - ---------- - results: list[GsaRecordLinkResult] - The results of this GsaRecordLinkResults. - """ - # Field is not nullable - if results is None: - raise ValueError("Invalid value for 'results', must not be 'None'") - # Field is required - if results is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'results', must not be 'Unset'") - self._results = results - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordLinkResults): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_property.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_property.py index 6cd020050..ac90d63bb 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_property.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_property.py @@ -59,4 +59,3 @@ class GsaRecordProperty(Enum): FULLNAME = "fullName" SHORTNAME = "shortName" RECORDCOLOR = "recordColor" - BREADCRUMBS = "breadcrumbs" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_reference_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_reference_criterion.py index ef3b45285..679dcacf8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_reference_criterion.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_reference_criterion.py @@ -66,8 +66,6 @@ class GsaRecordReferenceCriterion(GsaCriterion): swagger_types: dict[str, str] = { "database_key": "str", "type": "GsaCriterionType", - "any_record_guids": "list[str]", - "any_record_history_guids": "list[str]", "record_guid": "str", "record_history_guid": "str", } @@ -75,8 +73,6 @@ class GsaRecordReferenceCriterion(GsaCriterion): attribute_map: dict[str, str] = { "database_key": "databaseKey", "type": "type", - "any_record_guids": "anyRecordGuids", - "any_record_history_guids": "anyRecordHistoryGuids", "record_guid": "recordGuid", "record_history_guid": "recordHistoryGuid", } @@ -90,8 +86,6 @@ def __init__( *, database_key: "str", type: "GsaCriterionType" = GsaCriterionType.REFERENCE, - any_record_guids: "list[str] | None | Unset_Type" = Unset, - any_record_history_guids: "list[str] | None | Unset_Type" = Unset, record_guid: "str | None | Unset_Type" = Unset, record_history_guid: "str | None | Unset_Type" = Unset, ) -> None: @@ -101,27 +95,19 @@ def __init__( ---------- database_key: str type: GsaCriterionType - any_record_guids: list[str] | None, optional - any_record_history_guids: list[str] | None, optional record_guid: str | None, optional record_history_guid: str | None, optional """ super().__init__(type=type) self._database_key: str - self._record_guid: str | None | Unset_Type = Unset self._record_history_guid: str | None | Unset_Type = Unset - self._any_record_history_guids: list[str] | None | Unset_Type = Unset - self._any_record_guids: list[str] | None | Unset_Type = Unset + self._record_guid: str | None | Unset_Type = Unset self.database_key = database_key - if record_guid is not Unset: - self.record_guid = record_guid if record_history_guid is not Unset: self.record_history_guid = record_history_guid - if any_record_history_guids is not Unset: - self.any_record_history_guids = any_record_history_guids - if any_record_guids is not Unset: - self.any_record_guids = any_record_guids + if record_guid is not Unset: + self.record_guid = record_guid @property def database_key(self) -> "str": @@ -151,28 +137,6 @@ def database_key(self, database_key: "str") -> None: raise ValueError("Invalid value for 'database_key', must not be 'Unset'") self._database_key = database_key - @property - def record_guid(self) -> "str | None | Unset_Type": - """Gets the record_guid of this GsaRecordReferenceCriterion. - - Returns - ------- - str | None | Unset_Type - The record_guid of this GsaRecordReferenceCriterion. - """ - return self._record_guid - - @record_guid.setter - def record_guid(self, record_guid: "str | None | Unset_Type") -> None: - """Sets the record_guid of this GsaRecordReferenceCriterion. - - Parameters - ---------- - record_guid: str | None | Unset_Type - The record_guid of this GsaRecordReferenceCriterion. - """ - self._record_guid = record_guid - @property def record_history_guid(self) -> "str | None | Unset_Type": """Gets the record_history_guid of this GsaRecordReferenceCriterion. @@ -196,50 +160,26 @@ def record_history_guid(self, record_history_guid: "str | None | Unset_Type") -> self._record_history_guid = record_history_guid @property - def any_record_history_guids(self) -> "list[str] | None | Unset_Type": - """Gets the any_record_history_guids of this GsaRecordReferenceCriterion. - - Returns - ------- - list[str] | None | Unset_Type - The any_record_history_guids of this GsaRecordReferenceCriterion. - """ - return self._any_record_history_guids - - @any_record_history_guids.setter - def any_record_history_guids( - self, any_record_history_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the any_record_history_guids of this GsaRecordReferenceCriterion. - - Parameters - ---------- - any_record_history_guids: list[str] | None | Unset_Type - The any_record_history_guids of this GsaRecordReferenceCriterion. - """ - self._any_record_history_guids = any_record_history_guids - - @property - def any_record_guids(self) -> "list[str] | None | Unset_Type": - """Gets the any_record_guids of this GsaRecordReferenceCriterion. + def record_guid(self) -> "str | None | Unset_Type": + """Gets the record_guid of this GsaRecordReferenceCriterion. Returns ------- - list[str] | None | Unset_Type - The any_record_guids of this GsaRecordReferenceCriterion. + str | None | Unset_Type + The record_guid of this GsaRecordReferenceCriterion. """ - return self._any_record_guids + return self._record_guid - @any_record_guids.setter - def any_record_guids(self, any_record_guids: "list[str] | None | Unset_Type") -> None: - """Sets the any_record_guids of this GsaRecordReferenceCriterion. + @record_guid.setter + def record_guid(self, record_guid: "str | None | Unset_Type") -> None: + """Sets the record_guid of this GsaRecordReferenceCriterion. Parameters ---------- - any_record_guids: list[str] | None | Unset_Type - The any_record_guids of this GsaRecordReferenceCriterion. + record_guid: str | None | Unset_Type + The record_guid of this GsaRecordReferenceCriterion. """ - self._any_record_guids = any_record_guids + self._record_guid = record_guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_type_criterion.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_type_criterion.py deleted file mode 100644 index 5184de9d3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_type_criterion.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRecordTypeCriterion(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "record_types": "list[GsaRecordType]", - } - - attribute_map: dict[str, str] = { - "record_types": "recordTypes", - } - - subtype_mapping: dict[str, str] = { - "recordTypes": "GsaRecordType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - record_types: "list[GsaRecordType] | None | Unset_Type" = Unset, - ) -> None: - """GsaRecordTypeCriterion - a model defined in Swagger - - Parameters - ---------- - record_types: list[GsaRecordType] | None, optional - """ - self._record_types: list[GsaRecordType] | None | Unset_Type = Unset - - if record_types is not Unset: - self.record_types = record_types - - @property - def record_types(self) -> "list[GsaRecordType] | None | Unset_Type": - """Gets the record_types of this GsaRecordTypeCriterion. - - Returns - ------- - list[GsaRecordType] | None | Unset_Type - The record_types of this GsaRecordTypeCriterion. - """ - return self._record_types - - @record_types.setter - def record_types(self, record_types: "list[GsaRecordType] | None | Unset_Type") -> None: - """Sets the record_types of this GsaRecordTypeCriterion. - - Parameters - ---------- - record_types: list[GsaRecordType] | None | Unset_Type - The record_types of this GsaRecordTypeCriterion. - """ - self._record_types = record_types - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRecordTypeCriterion): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_version.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_version.py index 338fe608a..67901d487 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_version.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_record_version.py @@ -61,6 +61,7 @@ class GsaRecordVersion(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { + "capabilities": "GsaRecordCapabilities", "created_by_user": "str", "created_date": "datetime", "database_key": "str", @@ -73,13 +74,13 @@ class GsaRecordVersion(ModelBase): "record_type": "GsaRecordType", "short_name": "str", "table": "GsaSlimTable", - "user_capabilities": "GsaRecordUserCapabilities", "version_number": "int", "version_state": "GsaVersionState", "released_date": "datetime", } attribute_map: dict[str, str] = { + "capabilities": "capabilities", "created_by_user": "createdByUser", "created_date": "createdDate", "database_key": "databaseKey", @@ -92,7 +93,6 @@ class GsaRecordVersion(ModelBase): "record_type": "recordType", "short_name": "shortName", "table": "table", - "user_capabilities": "userCapabilities", "version_number": "versionNumber", "version_state": "versionState", "released_date": "releasedDate", @@ -103,7 +103,7 @@ class GsaRecordVersion(ModelBase): "table": "GsaSlimTable", "recordType": "GsaRecordType", "recordColor": "GsaRecordColor", - "userCapabilities": "GsaRecordUserCapabilities", + "capabilities": "GsaRecordCapabilities", "versionState": "GsaVersionState", } @@ -112,6 +112,7 @@ class GsaRecordVersion(ModelBase): def __init__( self, *, + capabilities: "GsaRecordCapabilities", created_by_user: "str", created_date: "datetime", database_key: "str", @@ -124,7 +125,6 @@ def __init__( record_type: "GsaRecordType", short_name: "str", table: "GsaSlimTable", - user_capabilities: "GsaRecordUserCapabilities", version_number: "int", version_state: "GsaVersionState", released_date: "datetime | None | Unset_Type" = Unset, @@ -133,6 +133,7 @@ def __init__( Parameters ---------- + capabilities: GsaRecordCapabilities created_by_user: str created_date: datetime database_key: str @@ -145,7 +146,6 @@ def __init__( record_type: GsaRecordType short_name: str table: GsaSlimTable - user_capabilities: GsaRecordUserCapabilities version_number: int version_state: GsaVersionState released_date: datetime | None, optional @@ -161,7 +161,7 @@ def __init__( self._released_date: datetime | None | Unset_Type = Unset self._short_name: str self._record_color: GsaRecordColor - self._user_capabilities: GsaRecordUserCapabilities + self._capabilities: GsaRecordCapabilities self._version_number: int self._version_state: GsaVersionState self._name: str @@ -179,7 +179,7 @@ def __init__( self.released_date = released_date self.short_name = short_name self.record_color = record_color - self.user_capabilities = user_capabilities + self.capabilities = capabilities self.version_number = version_number self.version_state = version_state self.name = name @@ -488,32 +488,32 @@ def record_color(self, record_color: "GsaRecordColor") -> None: self._record_color = record_color @property - def user_capabilities(self) -> "GsaRecordUserCapabilities": - """Gets the user_capabilities of this GsaRecordVersion. + def capabilities(self) -> "GsaRecordCapabilities": + """Gets the capabilities of this GsaRecordVersion. Returns ------- - GsaRecordUserCapabilities - The user_capabilities of this GsaRecordVersion. + GsaRecordCapabilities + The capabilities of this GsaRecordVersion. """ - return self._user_capabilities + return self._capabilities - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaRecordUserCapabilities") -> None: - """Sets the user_capabilities of this GsaRecordVersion. + @capabilities.setter + def capabilities(self, capabilities: "GsaRecordCapabilities") -> None: + """Sets the capabilities of this GsaRecordVersion. Parameters ---------- - user_capabilities: GsaRecordUserCapabilities - The user_capabilities of this GsaRecordVersion. + capabilities: GsaRecordCapabilities + The capabilities of this GsaRecordVersion. """ # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") + if capabilities is None: + raise ValueError("Invalid value for 'capabilities', must not be 'None'") # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities + if capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'capabilities', must not be 'Unset'") + self._capabilities = capabilities @property def version_number(self) -> "int": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referenced_by_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referenced_by_type.py index 78873f035..b254b084a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referenced_by_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referenced_by_type.py @@ -44,7 +44,7 @@ class GsaReferencedByType(Enum): """ EXPRESSION = "expression" VERSIONCONTROLLEDDATA = "versionControlledData" - SMARTLINKGROUP = "smartLinkGroup" + DYNAMICLINKGROUP = "dynamicLinkGroup" TABULARATTRIBUTE = "tabularAttribute" XYCHARTTEMPLATE = "xyChartTemplate" SEARCHMASK = "searchMask" @@ -52,10 +52,3 @@ class GsaReferencedByType(Enum): ATTRIBUTE = "attribute" DATA = "data" DEFAULTPARAMETERVALUE = "defaultParameterValue" - FUNCTIONALDATADEFAULT = "functionalDataDefault" - MULTIVALUEDPOINTDATA = "multiValuedPointData" - TABULARCOLUMN = "tabularColumn" - DATABASECURRENCYUNIT = "databaseCurrencyUnit" - UNIT = "unit" - PARAMETER = "parameter" - CONSTANT = "constant" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referential_integrity_model_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referential_integrity_model_record_link_group_error_detail.py deleted file mode 100644 index 41c639379..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_referential_integrity_model_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReferentialIntegrityModelRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REFERENTIALINTEGRITYMODEL, - ) -> None: - """GsaReferentialIntegrityModelRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReferentialIntegrityModelRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_register_update_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_register_update_request.py deleted file mode 100644 index 526116755..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_register_update_request.py +++ /dev/null @@ -1,184 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRegisterUpdateRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "apply_options": "GsaApplyOptions", - "header": "GsaDataUpdateHeader", - } - - attribute_map: dict[str, str] = { - "apply_options": "applyOptions", - "header": "header", - } - - subtype_mapping: dict[str, str] = { - "header": "GsaDataUpdateHeader", - "applyOptions": "GsaApplyOptions", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - apply_options: "GsaApplyOptions", - header: "GsaDataUpdateHeader", - ) -> None: - """GsaRegisterUpdateRequest - a model defined in Swagger - - Parameters - ---------- - apply_options: GsaApplyOptions - header: GsaDataUpdateHeader - """ - self._header: GsaDataUpdateHeader - self._apply_options: GsaApplyOptions - - self.header = header - self.apply_options = apply_options - - @property - def header(self) -> "GsaDataUpdateHeader": - """Gets the header of this GsaRegisterUpdateRequest. - - Returns - ------- - GsaDataUpdateHeader - The header of this GsaRegisterUpdateRequest. - """ - return self._header - - @header.setter - def header(self, header: "GsaDataUpdateHeader") -> None: - """Sets the header of this GsaRegisterUpdateRequest. - - Parameters - ---------- - header: GsaDataUpdateHeader - The header of this GsaRegisterUpdateRequest. - """ - # Field is not nullable - if header is None: - raise ValueError("Invalid value for 'header', must not be 'None'") - # Field is required - if header is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'header', must not be 'Unset'") - self._header = header - - @property - def apply_options(self) -> "GsaApplyOptions": - """Gets the apply_options of this GsaRegisterUpdateRequest. - - Returns - ------- - GsaApplyOptions - The apply_options of this GsaRegisterUpdateRequest. - """ - return self._apply_options - - @apply_options.setter - def apply_options(self, apply_options: "GsaApplyOptions") -> None: - """Sets the apply_options of this GsaRegisterUpdateRequest. - - Parameters - ---------- - apply_options: GsaApplyOptions - The apply_options of this GsaRegisterUpdateRequest. - """ - # Field is not nullable - if apply_options is None: - raise ValueError("Invalid value for 'apply_options', must not be 'None'") - # Field is required - if apply_options is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'apply_options', must not be 'Unset'") - self._apply_options = apply_options - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRegisterUpdateRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_record_version_control_exception.py index fcb56924a..488169108 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_record_version_control_exception.py @@ -61,7 +61,7 @@ class GsaReleaseRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaReleaseRecordVersionControlException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -82,7 +82,7 @@ class GsaReleaseRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaReleaseRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaReleaseRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseRecordVersionControlException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_table_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_table_version_control_exception.py index 493460914..462fcf1ff 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_table_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_release_table_version_control_exception.py @@ -61,7 +61,7 @@ class GsaReleaseTableVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaReleaseTableVersionControlException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -82,7 +82,7 @@ class GsaReleaseTableVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaReleaseTableVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseTableVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaReleaseTableVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaReleaseTableVersionControlException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_categories_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_categories_request.py deleted file mode 100644 index 99b14c772..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_categories_request.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReplacePermissionCategoriesRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "categories": "list[GsaPutPermissionCategory]", - } - - attribute_map: dict[str, str] = { - "categories": "categories", - } - - subtype_mapping: dict[str, str] = { - "categories": "GsaPutPermissionCategory", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - categories: "list[GsaPutPermissionCategory]", - ) -> None: - """GsaReplacePermissionCategoriesRequest - a model defined in Swagger - - Parameters - ---------- - categories: list[GsaPutPermissionCategory] - """ - self._categories: list[GsaPutPermissionCategory] - - self.categories = categories - - @property - def categories(self) -> "list[GsaPutPermissionCategory]": - """Gets the categories of this GsaReplacePermissionCategoriesRequest. - This can result in adding, modifying and deleting permission categories. To insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory). To modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory). Existing categories will be matched by GUID. If an existing category is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermissionCategory] - The categories of this GsaReplacePermissionCategoriesRequest. - """ - return self._categories - - @categories.setter - def categories(self, categories: "list[GsaPutPermissionCategory]") -> None: - """Sets the categories of this GsaReplacePermissionCategoriesRequest. - This can result in adding, modifying and deleting permission categories. To insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory). To modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory). Existing categories will be matched by GUID. If an existing category is not included, it will be deleted. - - Parameters - ---------- - categories: list[GsaPutPermissionCategory] - The categories of this GsaReplacePermissionCategoriesRequest. - """ - # Field is not nullable - if categories is None: - raise ValueError("Invalid value for 'categories', must not be 'None'") - # Field is required - if categories is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'categories', must not be 'Unset'") - self._categories = categories - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReplacePermissionCategoriesRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_detail.py deleted file mode 100644 index 512dec12b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReplacePermissionCategoryErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - discriminator_value_class_map = { - "duplicateCategories".lower(): "#/components/schemas/GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "category".lower(): "#/components/schemas/GsaCategoryReplacePermissionCategoryErrorDetail", - "noSuchCategories".lower(): "#/components/schemas/GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "tooManyPermissions".lower(): "#/components/schemas/GsaTooManyPermissionsReplacePermissionCategoryErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaReplacePermissionCategoryErrorReason", - ) -> None: - """GsaReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaReplacePermissionCategoryErrorReason - """ - self._message: str - self._reason: GsaReplacePermissionCategoryErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaReplacePermissionCategoryErrorDetail. - - Returns - ------- - str - The message of this GsaReplacePermissionCategoryErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaReplacePermissionCategoryErrorReason": - """Gets the reason of this GsaReplacePermissionCategoryErrorDetail. - - Returns - ------- - GsaReplacePermissionCategoryErrorReason - The reason of this GsaReplacePermissionCategoryErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaReplacePermissionCategoryErrorReason") -> None: - """Sets the reason of this GsaReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - reason: GsaReplacePermissionCategoryErrorReason - The reason of this GsaReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_reason.py deleted file mode 100644 index 5949d3bd9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_replace_permission_category_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaReplacePermissionCategoryErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - DUPLICATECATEGORIES = "duplicateCategories" - CATEGORY = "category" - NOSUCHCATEGORIES = "noSuchCategories" - TOOMANYPERMISSIONS = "tooManyPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_info.py deleted file mode 100644 index 6012ba651..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolveLinkTargetsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "resolved_link_targets": "list[GsaResolvedLinkTarget]", - } - - attribute_map: dict[str, str] = { - "resolved_link_targets": "resolvedLinkTargets", - } - - subtype_mapping: dict[str, str] = { - "resolvedLinkTargets": "GsaResolvedLinkTarget", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - resolved_link_targets: "list[GsaResolvedLinkTarget]", - ) -> None: - """GsaResolveLinkTargetsInfo - a model defined in Swagger - - Parameters - ---------- - resolved_link_targets: list[GsaResolvedLinkTarget] - """ - self._resolved_link_targets: list[GsaResolvedLinkTarget] - - self.resolved_link_targets = resolved_link_targets - - @property - def resolved_link_targets(self) -> "list[GsaResolvedLinkTarget]": - """Gets the resolved_link_targets of this GsaResolveLinkTargetsInfo. - - Returns - ------- - list[GsaResolvedLinkTarget] - The resolved_link_targets of this GsaResolveLinkTargetsInfo. - """ - return self._resolved_link_targets - - @resolved_link_targets.setter - def resolved_link_targets(self, resolved_link_targets: "list[GsaResolvedLinkTarget]") -> None: - """Sets the resolved_link_targets of this GsaResolveLinkTargetsInfo. - - Parameters - ---------- - resolved_link_targets: list[GsaResolvedLinkTarget] - The resolved_link_targets of this GsaResolveLinkTargetsInfo. - """ - # Field is not nullable - if resolved_link_targets is None: - raise ValueError("Invalid value for 'resolved_link_targets', must not be 'None'") - # Field is required - if resolved_link_targets is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'resolved_link_targets', must not be 'Unset'") - self._resolved_link_targets = resolved_link_targets - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolveLinkTargetsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_request.py deleted file mode 100644 index 94f214be3..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolve_link_targets_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolveLinkTargetsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "link_targets": "list[GsaLinkTarget]", - } - - attribute_map: dict[str, str] = { - "link_targets": "linkTargets", - } - - subtype_mapping: dict[str, str] = { - "linkTargets": "GsaLinkTarget", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - link_targets: "list[GsaLinkTarget]", - ) -> None: - """GsaResolveLinkTargetsRequest - a model defined in Swagger - - Parameters - ---------- - link_targets: list[GsaLinkTarget] - """ - self._link_targets: list[GsaLinkTarget] - - self.link_targets = link_targets - - @property - def link_targets(self) -> "list[GsaLinkTarget]": - """Gets the link_targets of this GsaResolveLinkTargetsRequest. - - Returns - ------- - list[GsaLinkTarget] - The link_targets of this GsaResolveLinkTargetsRequest. - """ - return self._link_targets - - @link_targets.setter - def link_targets(self, link_targets: "list[GsaLinkTarget]") -> None: - """Sets the link_targets of this GsaResolveLinkTargetsRequest. - - Parameters - ---------- - link_targets: list[GsaLinkTarget] - The link_targets of this GsaResolveLinkTargetsRequest. - """ - # Field is not nullable - if link_targets is None: - raise ValueError("Invalid value for 'link_targets', must not be 'None'") - # Field is required - if link_targets is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_targets', must not be 'Unset'") - self._link_targets = link_targets - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolveLinkTargetsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link.py similarity index 73% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link.py index 9fa9fe636..1630bdea1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_link.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link.py @@ -42,7 +42,7 @@ from . import * -class GsaLink(ModelBase): +class GsaResolvedLink(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -57,18 +57,17 @@ class GsaLink(ModelBase): The key is attribute name and the value is json key in definition. subtype_mapping: dict[str, str] The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. discriminator: Optional[str] Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { "display_names": "dict(str, str)", "guid": "str", - "link_info": "GsaLinkInfo", + "link_info": "GsaResolvedLinkInfo", "name": "str", "reverse_name": "str", "type": "GsaLinkAttributeType", + "identity": "int", "reverse_display_names": "dict(str, str)", } @@ -79,54 +78,53 @@ class GsaLink(ModelBase): "name": "name", "reverse_name": "reverseName", "type": "type", + "identity": "identity", "reverse_display_names": "reverseDisplayNames", } subtype_mapping: dict[str, str] = { "type": "GsaLinkAttributeType", - "linkInfo": "GsaLinkInfo", + "linkInfo": "GsaResolvedLinkInfo", } - discriminator_value_class_map = { - "recordLink".lower(): "#/components/schemas/GsaRecordLink", - "smartLink".lower(): "#/components/schemas/GsaSmartLink", - "crossDatabaseLink".lower(): "#/components/schemas/GsaCrossDatabaseLink", - "tabularAttribute".lower(): "#/components/schemas/GsaTabularAttributeLink", - } - - discriminator: Optional[str] = "type" + discriminator: Optional[str] = None def __init__( self, *, display_names: "dict[str, str]", guid: "str", - link_info: "GsaLinkInfo", + link_info: "GsaResolvedLinkInfo", name: "str", reverse_name: "str", type: "GsaLinkAttributeType", + identity: "int | None | Unset_Type" = Unset, reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, ) -> None: - """GsaLink - a model defined in Swagger + """GsaResolvedLink - a model defined in Swagger Parameters ---------- display_names: dict[str, str] guid: str - link_info: GsaLinkInfo + link_info: GsaResolvedLinkInfo name: str reverse_name: str type: GsaLinkAttributeType + identity: int | None, optional reverse_display_names: dict[str, str] | None, optional """ + self._identity: int | None | Unset_Type = Unset self._type: GsaLinkAttributeType self._reverse_name: str self._reverse_display_names: dict[str, str] | None | Unset_Type = Unset - self._link_info: GsaLinkInfo + self._link_info: GsaResolvedLinkInfo self._display_names: dict[str, str] self._name: str self._guid: str + if identity is not Unset: + self.identity = identity self.type = type self.reverse_name = reverse_name if reverse_display_names is not Unset: @@ -136,25 +134,47 @@ def __init__( self.name = name self.guid = guid + @property + def identity(self) -> "int | None | Unset_Type": + """Gets the identity of this GsaResolvedLink. + + Returns + ------- + int | None | Unset_Type + The identity of this GsaResolvedLink. + """ + return self._identity + + @identity.setter + def identity(self, identity: "int | None | Unset_Type") -> None: + """Sets the identity of this GsaResolvedLink. + + Parameters + ---------- + identity: int | None | Unset_Type + The identity of this GsaResolvedLink. + """ + self._identity = identity + @property def type(self) -> "GsaLinkAttributeType": - """Gets the type of this GsaLink. + """Gets the type of this GsaResolvedLink. Returns ------- GsaLinkAttributeType - The type of this GsaLink. + The type of this GsaResolvedLink. """ return self._type @type.setter def type(self, type: "GsaLinkAttributeType") -> None: - """Sets the type of this GsaLink. + """Sets the type of this GsaResolvedLink. Parameters ---------- type: GsaLinkAttributeType - The type of this GsaLink. + The type of this GsaResolvedLink. """ # Field is not nullable if type is None: @@ -166,23 +186,23 @@ def type(self, type: "GsaLinkAttributeType") -> None: @property def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaLink. + """Gets the reverse_name of this GsaResolvedLink. Returns ------- str - The reverse_name of this GsaLink. + The reverse_name of this GsaResolvedLink. """ return self._reverse_name @reverse_name.setter def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaLink. + """Sets the reverse_name of this GsaResolvedLink. Parameters ---------- reverse_name: str - The reverse_name of this GsaLink. + The reverse_name of this GsaResolvedLink. """ # Field is not nullable if reverse_name is None: @@ -194,12 +214,12 @@ def reverse_name(self, reverse_name: "str") -> None: @property def reverse_display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the reverse_display_names of this GsaLink. + """Gets the reverse_display_names of this GsaResolvedLink. Returns ------- dict[str, str] | None | Unset_Type - The reverse_display_names of this GsaLink. + The reverse_display_names of this GsaResolvedLink. """ return self._reverse_display_names @@ -207,34 +227,34 @@ def reverse_display_names(self) -> "dict[str, str] | None | Unset_Type": def reverse_display_names( self, reverse_display_names: "dict[str, str] | None | Unset_Type" ) -> None: - """Sets the reverse_display_names of this GsaLink. + """Sets the reverse_display_names of this GsaResolvedLink. Parameters ---------- reverse_display_names: dict[str, str] | None | Unset_Type - The reverse_display_names of this GsaLink. + The reverse_display_names of this GsaResolvedLink. """ self._reverse_display_names = reverse_display_names @property - def link_info(self) -> "GsaLinkInfo": - """Gets the link_info of this GsaLink. + def link_info(self) -> "GsaResolvedLinkInfo": + """Gets the link_info of this GsaResolvedLink. Returns ------- - GsaLinkInfo - The link_info of this GsaLink. + GsaResolvedLinkInfo + The link_info of this GsaResolvedLink. """ return self._link_info @link_info.setter - def link_info(self, link_info: "GsaLinkInfo") -> None: - """Sets the link_info of this GsaLink. + def link_info(self, link_info: "GsaResolvedLinkInfo") -> None: + """Sets the link_info of this GsaResolvedLink. Parameters ---------- - link_info: GsaLinkInfo - The link_info of this GsaLink. + link_info: GsaResolvedLinkInfo + The link_info of this GsaResolvedLink. """ # Field is not nullable if link_info is None: @@ -246,25 +266,23 @@ def link_info(self, link_info: "GsaLinkInfo") -> None: @property def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaLink. - A dictionary of the culture name to the name that should be used in that culture for the item + """Gets the display_names of this GsaResolvedLink. Returns ------- dict[str, str] - The display_names of this GsaLink. + The display_names of this GsaResolvedLink. """ return self._display_names @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaLink. - A dictionary of the culture name to the name that should be used in that culture for the item + """Sets the display_names of this GsaResolvedLink. Parameters ---------- display_names: dict[str, str] - The display_names of this GsaLink. + The display_names of this GsaResolvedLink. """ # Field is not nullable if display_names is None: @@ -276,23 +294,23 @@ def display_names(self, display_names: "dict[str, str]") -> None: @property def name(self) -> "str": - """Gets the name of this GsaLink. + """Gets the name of this GsaResolvedLink. Returns ------- str - The name of this GsaLink. + The name of this GsaResolvedLink. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaLink. + """Sets the name of this GsaResolvedLink. Parameters ---------- name: str - The name of this GsaLink. + The name of this GsaResolvedLink. """ # Field is not nullable if name is None: @@ -304,23 +322,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaLink. + """Gets the guid of this GsaResolvedLink. Returns ------- str - The guid of this GsaLink. + The guid of this GsaResolvedLink. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaLink. + """Sets the guid of this GsaResolvedLink. Parameters ---------- guid: str - The guid of this GsaLink. + The guid of this GsaResolvedLink. """ # Field is not nullable if guid is None: @@ -332,24 +350,19 @@ def guid(self, guid: "str") -> None: @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator + """Raises a NotImplementedError for a type without a discriminator defined. Parameters ---------- data: ModelBase Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() def __repr__(self) -> str: """For 'print' and 'pprint'""" @@ -357,7 +370,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaLink): + if not isinstance(other, GsaResolvedLink): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_info.py similarity index 60% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_mapping.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_info.py index 6378a6cd6..aeb639098 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_unit_mapping.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_info.py @@ -42,7 +42,7 @@ from . import * -class GsaCreateUnitMapping(ModelBase): +class GsaResolvedLinkInfo(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,18 +61,18 @@ class GsaCreateUnitMapping(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "equivalent_unit": "GsaSlimEntity", - "unit": "GsaSlimEntity", + "link_source": "GsaResolvedLinkTarget", + "link_target": "GsaResolvedLinkTarget", } attribute_map: dict[str, str] = { - "equivalent_unit": "equivalentUnit", - "unit": "unit", + "link_source": "linkSource", + "link_target": "linkTarget", } subtype_mapping: dict[str, str] = { - "unit": "GsaSlimEntity", - "equivalentUnit": "GsaSlimEntity", + "linkSource": "GsaResolvedLinkTarget", + "linkTarget": "GsaResolvedLinkTarget", } discriminator: Optional[str] = None @@ -80,77 +80,77 @@ class GsaCreateUnitMapping(ModelBase): def __init__( self, *, - equivalent_unit: "GsaSlimEntity", - unit: "GsaSlimEntity", + link_source: "GsaResolvedLinkTarget", + link_target: "GsaResolvedLinkTarget", ) -> None: - """GsaCreateUnitMapping - a model defined in Swagger + """GsaResolvedLinkInfo - a model defined in Swagger Parameters ---------- - equivalent_unit: GsaSlimEntity - unit: GsaSlimEntity + link_source: GsaResolvedLinkTarget + link_target: GsaResolvedLinkTarget """ - self._unit: GsaSlimEntity - self._equivalent_unit: GsaSlimEntity + self._link_source: GsaResolvedLinkTarget + self._link_target: GsaResolvedLinkTarget - self.unit = unit - self.equivalent_unit = equivalent_unit + self.link_source = link_source + self.link_target = link_target @property - def unit(self) -> "GsaSlimEntity": - """Gets the unit of this GsaCreateUnitMapping. + def link_source(self) -> "GsaResolvedLinkTarget": + """Gets the link_source of this GsaResolvedLinkInfo. Returns ------- - GsaSlimEntity - The unit of this GsaCreateUnitMapping. + GsaResolvedLinkTarget + The link_source of this GsaResolvedLinkInfo. """ - return self._unit + return self._link_source - @unit.setter - def unit(self, unit: "GsaSlimEntity") -> None: - """Sets the unit of this GsaCreateUnitMapping. + @link_source.setter + def link_source(self, link_source: "GsaResolvedLinkTarget") -> None: + """Sets the link_source of this GsaResolvedLinkInfo. Parameters ---------- - unit: GsaSlimEntity - The unit of this GsaCreateUnitMapping. + link_source: GsaResolvedLinkTarget + The link_source of this GsaResolvedLinkInfo. """ # Field is not nullable - if unit is None: - raise ValueError("Invalid value for 'unit', must not be 'None'") + if link_source is None: + raise ValueError("Invalid value for 'link_source', must not be 'None'") # Field is required - if unit is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit', must not be 'Unset'") - self._unit = unit + if link_source is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_source', must not be 'Unset'") + self._link_source = link_source @property - def equivalent_unit(self) -> "GsaSlimEntity": - """Gets the equivalent_unit of this GsaCreateUnitMapping. + def link_target(self) -> "GsaResolvedLinkTarget": + """Gets the link_target of this GsaResolvedLinkInfo. Returns ------- - GsaSlimEntity - The equivalent_unit of this GsaCreateUnitMapping. + GsaResolvedLinkTarget + The link_target of this GsaResolvedLinkInfo. """ - return self._equivalent_unit + return self._link_target - @equivalent_unit.setter - def equivalent_unit(self, equivalent_unit: "GsaSlimEntity") -> None: - """Sets the equivalent_unit of this GsaCreateUnitMapping. + @link_target.setter + def link_target(self, link_target: "GsaResolvedLinkTarget") -> None: + """Sets the link_target of this GsaResolvedLinkInfo. Parameters ---------- - equivalent_unit: GsaSlimEntity - The equivalent_unit of this GsaCreateUnitMapping. + link_target: GsaResolvedLinkTarget + The link_target of this GsaResolvedLinkInfo. """ # Field is not nullable - if equivalent_unit is None: - raise ValueError("Invalid value for 'equivalent_unit', must not be 'None'") + if link_target is None: + raise ValueError("Invalid value for 'link_target', must not be 'None'") # Field is required - if equivalent_unit is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equivalent_unit', must not be 'Unset'") - self._equivalent_unit = equivalent_unit + if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'link_target', must not be 'Unset'") + self._link_target = link_target @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -174,7 +174,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateUnitMapping): + if not isinstance(other, GsaResolvedLinkInfo): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_target.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_target.py index b99d0f8d2..2466f187d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_target.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_link_target.py @@ -61,96 +61,127 @@ class GsaResolvedLinkTarget(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "link_target": "GsaLinkTarget", - "tables": "list[GsaSlimTable]", + "database_guid": "str", + "database_version_guid": "str", + "table_guid": "str", } attribute_map: dict[str, str] = { - "link_target": "linkTarget", - "tables": "tables", + "database_guid": "databaseGuid", + "database_version_guid": "databaseVersionGuid", + "table_guid": "tableGuid", } - subtype_mapping: dict[str, str] = { - "linkTarget": "GsaLinkTarget", - "tables": "GsaSlimTable", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - link_target: "GsaLinkTarget", - tables: "list[GsaSlimTable]", + database_guid: "str", + database_version_guid: "str", + table_guid: "str", ) -> None: """GsaResolvedLinkTarget - a model defined in Swagger Parameters ---------- - link_target: GsaLinkTarget - tables: list[GsaSlimTable] + database_guid: str + database_version_guid: str + table_guid: str + """ + self._database_guid: str + self._database_version_guid: str + self._table_guid: str + + self.database_guid = database_guid + self.database_version_guid = database_version_guid + self.table_guid = table_guid + + @property + def database_guid(self) -> "str": + """Gets the database_guid of this GsaResolvedLinkTarget. + + Returns + ------- + str + The database_guid of this GsaResolvedLinkTarget. """ - self._link_target: GsaLinkTarget - self._tables: list[GsaSlimTable] + return self._database_guid + + @database_guid.setter + def database_guid(self, database_guid: "str") -> None: + """Sets the database_guid of this GsaResolvedLinkTarget. - self.link_target = link_target - self.tables = tables + Parameters + ---------- + database_guid: str + The database_guid of this GsaResolvedLinkTarget. + """ + # Field is not nullable + if database_guid is None: + raise ValueError("Invalid value for 'database_guid', must not be 'None'") + # Field is required + if database_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'database_guid', must not be 'Unset'") + self._database_guid = database_guid @property - def link_target(self) -> "GsaLinkTarget": - """Gets the link_target of this GsaResolvedLinkTarget. + def database_version_guid(self) -> "str": + """Gets the database_version_guid of this GsaResolvedLinkTarget. Returns ------- - GsaLinkTarget - The link_target of this GsaResolvedLinkTarget. + str + The database_version_guid of this GsaResolvedLinkTarget. """ - return self._link_target + return self._database_version_guid - @link_target.setter - def link_target(self, link_target: "GsaLinkTarget") -> None: - """Sets the link_target of this GsaResolvedLinkTarget. + @database_version_guid.setter + def database_version_guid(self, database_version_guid: "str") -> None: + """Sets the database_version_guid of this GsaResolvedLinkTarget. Parameters ---------- - link_target: GsaLinkTarget - The link_target of this GsaResolvedLinkTarget. + database_version_guid: str + The database_version_guid of this GsaResolvedLinkTarget. """ # Field is not nullable - if link_target is None: - raise ValueError("Invalid value for 'link_target', must not be 'None'") + if database_version_guid is None: + raise ValueError("Invalid value for 'database_version_guid', must not be 'None'") # Field is required - if link_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_target', must not be 'Unset'") - self._link_target = link_target + if database_version_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'database_version_guid', must not be 'Unset'") + self._database_version_guid = database_version_guid @property - def tables(self) -> "list[GsaSlimTable]": - """Gets the tables of this GsaResolvedLinkTarget. + def table_guid(self) -> "str": + """Gets the table_guid of this GsaResolvedLinkTarget. Returns ------- - list[GsaSlimTable] - The tables of this GsaResolvedLinkTarget. + str + The table_guid of this GsaResolvedLinkTarget. """ - return self._tables + return self._table_guid - @tables.setter - def tables(self, tables: "list[GsaSlimTable]") -> None: - """Sets the tables of this GsaResolvedLinkTarget. + @table_guid.setter + def table_guid(self, table_guid: "str") -> None: + """Sets the table_guid of this GsaResolvedLinkTarget. Parameters ---------- - tables: list[GsaSlimTable] - The tables of this GsaResolvedLinkTarget. + table_guid: str + The table_guid of this GsaResolvedLinkTarget. """ # Field is not nullable - if tables is None: - raise ValueError("Invalid value for 'tables', must not be 'None'") + if table_guid is None: + raise ValueError("Invalid value for 'table_guid', must not be 'None'") # Field is required - if tables is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'tables', must not be 'Unset'") - self._tables = tables + if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") + self._table_guid = table_guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_target_attribute.py deleted file mode 100644 index 4042b53cb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_resolved_target_attribute.py +++ /dev/null @@ -1,266 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_target_attribute import ( # noqa: F401 - GsaTargetAttribute, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_target_attribute_type import ( - GsaTargetAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaResolvedTargetAttribute(GsaTargetAttribute): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_type": "GsaAttributeType", - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "target_type": "GsaTargetAttributeType", - "about_attribute": "GsaSlimTypedAttribute", - } - - attribute_map: dict[str, str] = { - "attribute_type": "attributeType", - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "target_type": "targetType", - "about_attribute": "aboutAttribute", - } - - subtype_mapping: dict[str, str] = { - "attributeType": "GsaAttributeType", - "aboutAttribute": "GsaSlimTypedAttribute", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_type: "GsaAttributeType", - display_names: "dict[str, str]", - guid: "str", - name: "str", - target_type: "GsaTargetAttributeType" = GsaTargetAttributeType.RESOLVED, - about_attribute: "GsaSlimTypedAttribute | Unset_Type" = Unset, - ) -> None: - """GsaResolvedTargetAttribute - a model defined in Swagger - - Parameters - ---------- - attribute_type: GsaAttributeType - display_names: dict[str, str] - guid: str - name: str - target_type: GsaTargetAttributeType - about_attribute: GsaSlimTypedAttribute, optional - """ - super().__init__(guid=guid, target_type=target_type) - self._name: str - self._display_names: dict[str, str] - self._attribute_type: GsaAttributeType - self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset - - self.name = name - self.display_names = display_names - self.attribute_type = attribute_type - if about_attribute is not Unset: - self.about_attribute = about_attribute - - @property - def name(self) -> "str": - """Gets the name of this GsaResolvedTargetAttribute. - - Returns - ------- - str - The name of this GsaResolvedTargetAttribute. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaResolvedTargetAttribute. - - Parameters - ---------- - name: str - The name of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaResolvedTargetAttribute. - - Returns - ------- - dict[str, str] - The display_names of this GsaResolvedTargetAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaResolvedTargetAttribute. - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def attribute_type(self) -> "GsaAttributeType": - """Gets the attribute_type of this GsaResolvedTargetAttribute. - - Returns - ------- - GsaAttributeType - The attribute_type of this GsaResolvedTargetAttribute. - """ - return self._attribute_type - - @attribute_type.setter - def attribute_type(self, attribute_type: "GsaAttributeType") -> None: - """Sets the attribute_type of this GsaResolvedTargetAttribute. - - Parameters - ---------- - attribute_type: GsaAttributeType - The attribute_type of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if attribute_type is None: - raise ValueError("Invalid value for 'attribute_type', must not be 'None'") - # Field is required - if attribute_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_type', must not be 'Unset'") - self._attribute_type = attribute_type - - @property - def about_attribute(self) -> "GsaSlimTypedAttribute | Unset_Type": - """Gets the about_attribute of this GsaResolvedTargetAttribute. - - Returns - ------- - GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaResolvedTargetAttribute. - """ - return self._about_attribute - - @about_attribute.setter - def about_attribute(self, about_attribute: "GsaSlimTypedAttribute | Unset_Type") -> None: - """Sets the about_attribute of this GsaResolvedTargetAttribute. - - Parameters - ---------- - about_attribute: GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaResolvedTargetAttribute. - """ - # Field is not nullable - if about_attribute is None: - raise ValueError("Invalid value for 'about_attribute', must not be 'None'") - self._about_attribute = about_attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaResolvedTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_potential_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_potential_request.py deleted file mode 100644 index ea76da187..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_potential_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetPotentialRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "target_database_keys": "list[str]", - } - - attribute_map: dict[str, str] = { - "target_database_keys": "targetDatabaseKeys", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - target_database_keys: "list[str]", - ) -> None: - """GsaRetargetPotentialRequest - a model defined in Swagger - - Parameters - ---------- - target_database_keys: list[str] - """ - self._target_database_keys: list[str] - - self.target_database_keys = target_database_keys - - @property - def target_database_keys(self) -> "list[str]": - """Gets the target_database_keys of this GsaRetargetPotentialRequest. - List of database keys to check for retargeting potential. - - Returns - ------- - list[str] - The target_database_keys of this GsaRetargetPotentialRequest. - """ - return self._target_database_keys - - @target_database_keys.setter - def target_database_keys(self, target_database_keys: "list[str]") -> None: - """Sets the target_database_keys of this GsaRetargetPotentialRequest. - List of database keys to check for retargeting potential. - - Parameters - ---------- - target_database_keys: list[str] - The target_database_keys of this GsaRetargetPotentialRequest. - """ - # Field is not nullable - if target_database_keys is None: - raise ValueError("Invalid value for 'target_database_keys', must not be 'None'") - # Field is required - if target_database_keys is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_database_keys', must not be 'Unset'") - self._target_database_keys = target_database_keys - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetPotentialRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_request.py deleted file mode 100644 index 5871f1e25..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_request.py +++ /dev/null @@ -1,187 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "new_target_database_key": "str", - "previous_target_database_key": "str", - } - - attribute_map: dict[str, str] = { - "new_target_database_key": "newTargetDatabaseKey", - "previous_target_database_key": "previousTargetDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - new_target_database_key: "str", - previous_target_database_key: "str", - ) -> None: - """GsaRetargetRequest - a model defined in Swagger - - Parameters - ---------- - new_target_database_key: str - previous_target_database_key: str - """ - self._previous_target_database_key: str - self._new_target_database_key: str - - self.previous_target_database_key = previous_target_database_key - self.new_target_database_key = new_target_database_key - - @property - def previous_target_database_key(self) -> "str": - """Gets the previous_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes were targeting before the operation. - - Returns - ------- - str - The previous_target_database_key of this GsaRetargetRequest. - """ - return self._previous_target_database_key - - @previous_target_database_key.setter - def previous_target_database_key(self, previous_target_database_key: "str") -> None: - """Sets the previous_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes were targeting before the operation. - - Parameters - ---------- - previous_target_database_key: str - The previous_target_database_key of this GsaRetargetRequest. - """ - # Field is not nullable - if previous_target_database_key is None: - raise ValueError("Invalid value for 'previous_target_database_key', must not be 'None'") - # Field is required - if previous_target_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'previous_target_database_key', must not be 'Unset'" - ) - self._previous_target_database_key = previous_target_database_key - - @property - def new_target_database_key(self) -> "str": - """Gets the new_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes will target after the operation. - - Returns - ------- - str - The new_target_database_key of this GsaRetargetRequest. - """ - return self._new_target_database_key - - @new_target_database_key.setter - def new_target_database_key(self, new_target_database_key: "str") -> None: - """Sets the new_target_database_key of this GsaRetargetRequest. - Database key that the tabular attributes will target after the operation. - - Parameters - ---------- - new_target_database_key: str - The new_target_database_key of this GsaRetargetRequest. - """ - # Field is not nullable - if new_target_database_key is None: - raise ValueError("Invalid value for 'new_target_database_key', must not be 'None'") - # Field is required - if new_target_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'new_target_database_key', must not be 'Unset'") - self._new_target_database_key = new_target_database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result.py deleted file mode 100644 index be69a4e77..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result.py +++ /dev/null @@ -1,257 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetResult(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_name": "str", - "result": "GsaRetargetResultType", - "source_database_key": "str", - "table_name": "str", - } - - attribute_map: dict[str, str] = { - "attribute_name": "attributeName", - "result": "result", - "source_database_key": "sourceDatabaseKey", - "table_name": "tableName", - } - - subtype_mapping: dict[str, str] = { - "result": "GsaRetargetResultType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_name: "str", - result: "GsaRetargetResultType", - source_database_key: "str", - table_name: "str", - ) -> None: - """GsaRetargetResult - a model defined in Swagger - - Parameters - ---------- - attribute_name: str - result: GsaRetargetResultType - source_database_key: str - table_name: str - """ - self._source_database_key: str - self._table_name: str - self._attribute_name: str - self._result: GsaRetargetResultType - - self.source_database_key = source_database_key - self.table_name = table_name - self.attribute_name = attribute_name - self.result = result - - @property - def source_database_key(self) -> "str": - """Gets the source_database_key of this GsaRetargetResult. - Database key of the source database - the one holding the tabular attribute that was retargeted. - - Returns - ------- - str - The source_database_key of this GsaRetargetResult. - """ - return self._source_database_key - - @source_database_key.setter - def source_database_key(self, source_database_key: "str") -> None: - """Sets the source_database_key of this GsaRetargetResult. - Database key of the source database - the one holding the tabular attribute that was retargeted. - - Parameters - ---------- - source_database_key: str - The source_database_key of this GsaRetargetResult. - """ - # Field is not nullable - if source_database_key is None: - raise ValueError("Invalid value for 'source_database_key', must not be 'None'") - # Field is required - if source_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'source_database_key', must not be 'Unset'") - self._source_database_key = source_database_key - - @property - def table_name(self) -> "str": - """Gets the table_name of this GsaRetargetResult. - Table name of the source table - the one holding the tabular attribute that was retargeted. - - Returns - ------- - str - The table_name of this GsaRetargetResult. - """ - return self._table_name - - @table_name.setter - def table_name(self, table_name: "str") -> None: - """Sets the table_name of this GsaRetargetResult. - Table name of the source table - the one holding the tabular attribute that was retargeted. - - Parameters - ---------- - table_name: str - The table_name of this GsaRetargetResult. - """ - # Field is not nullable - if table_name is None: - raise ValueError("Invalid value for 'table_name', must not be 'None'") - # Field is required - if table_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_name', must not be 'Unset'") - self._table_name = table_name - - @property - def attribute_name(self) -> "str": - """Gets the attribute_name of this GsaRetargetResult. - Name of the tabular attribute that was retargeted. - - Returns - ------- - str - The attribute_name of this GsaRetargetResult. - """ - return self._attribute_name - - @attribute_name.setter - def attribute_name(self, attribute_name: "str") -> None: - """Sets the attribute_name of this GsaRetargetResult. - Name of the tabular attribute that was retargeted. - - Parameters - ---------- - attribute_name: str - The attribute_name of this GsaRetargetResult. - """ - # Field is not nullable - if attribute_name is None: - raise ValueError("Invalid value for 'attribute_name', must not be 'None'") - # Field is required - if attribute_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_name', must not be 'Unset'") - self._attribute_name = attribute_name - - @property - def result(self) -> "GsaRetargetResultType": - """Gets the result of this GsaRetargetResult. - - Returns - ------- - GsaRetargetResultType - The result of this GsaRetargetResult. - """ - return self._result - - @result.setter - def result(self, result: "GsaRetargetResultType") -> None: - """Sets the result of this GsaRetargetResult. - - Parameters - ---------- - result: GsaRetargetResultType - The result of this GsaRetargetResult. - """ - # Field is not nullable - if result is None: - raise ValueError("Invalid value for 'result', must not be 'None'") - # Field is required - if result is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'result', must not be 'Unset'") - self._result = result - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result_type.py deleted file mode 100644 index 45eee2384..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_result_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaRetargetResultType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - SUCCESS = "success" - TABLENOTFOUND = "tableNotFound" - LINKINGATTRIBUTENOTFOUND = "linkingAttributeNotFound" - COLUMNMISSING = "columnMissing" - MISSINGADMINPERMISSIONS = "missingAdminPermissions" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_results_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_results_info.py deleted file mode 100644 index 8d966a5b6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_retarget_results_info.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRetargetResultsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "results": "list[GsaRetargetResult]", - } - - attribute_map: dict[str, str] = { - "results": "results", - } - - subtype_mapping: dict[str, str] = { - "results": "GsaRetargetResult", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - results: "list[GsaRetargetResult]", - ) -> None: - """GsaRetargetResultsInfo - a model defined in Swagger - - Parameters - ---------- - results: list[GsaRetargetResult] - """ - self._results: list[GsaRetargetResult] - - self.results = results - - @property - def results(self) -> "list[GsaRetargetResult]": - """Gets the results of this GsaRetargetResultsInfo. - - Returns - ------- - list[GsaRetargetResult] - The results of this GsaRetargetResultsInfo. - """ - return self._results - - @results.setter - def results(self, results: "list[GsaRetargetResult]") -> None: - """Sets the results of this GsaRetargetResultsInfo. - - Parameters - ---------- - results: list[GsaRetargetResult] - The results of this GsaRetargetResultsInfo. - """ - # Field is not nullable - if results is None: - raise ValueError("Invalid value for 'results', must not be 'None'") - # Field is required - if results is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'results', must not be 'Unset'") - self._results = results - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRetargetResultsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py deleted file mode 100644 index 314074e4e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_as_name_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "reverse_name": "str", - "target_table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "reverse_name": "reverseName", - "target_table_guid": "targetTableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMEALREADYEXISTSASNAME, - reverse_name: "str", - target_table_guid: "str", - ) -> None: - """GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - reverse_name: str - target_table_guid: str - """ - super().__init__(message=message, reason=reason) - self._reverse_name: str - self._target_table_guid: str - - self.reverse_name = reverse_name - self.target_table_guid = target_table_guid - - @property - def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Returns - ------- - str - The reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - return self._reverse_name - - @reverse_name.setter - def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Parameters - ---------- - reverse_name: str - The reverse_name of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reverse_name is None: - raise ValueError("Invalid value for 'reverse_name', must not be 'None'") - # Field is required - if reverse_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reverse_name', must not be 'Unset'") - self._reverse_name = reverse_name - - @property - def target_table_guid(self) -> "str": - """Gets the target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Returns - ------- - str - The target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - return self._target_table_guid - - @target_table_guid.setter - def target_table_guid(self, target_table_guid: "str") -> None: - """Sets the target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - - Parameters - ---------- - target_table_guid: str - The target_table_guid of this GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if target_table_guid is None: - raise ValueError("Invalid value for 'target_table_guid', must not be 'None'") - # Field is required - if target_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_table_guid', must not be 'Unset'") - self._target_table_guid = target_table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py deleted file mode 100644 index 5ba2d7643..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_already_exists_record_link_group_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - "reverse_name": "str", - "target_table_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "reverse_name": "reverseName", - "target_table_guid": "targetTableGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMEALREADYEXISTS, - reverse_name: "str", - target_table_guid: "str", - ) -> None: - """GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - reverse_name: str - target_table_guid: str - """ - super().__init__(message=message, reason=reason) - self._reverse_name: str - self._target_table_guid: str - - self.reverse_name = reverse_name - self.target_table_guid = target_table_guid - - @property - def reverse_name(self) -> "str": - """Gets the reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Returns - ------- - str - The reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - return self._reverse_name - - @reverse_name.setter - def reverse_name(self, reverse_name: "str") -> None: - """Sets the reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Parameters - ---------- - reverse_name: str - The reverse_name of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if reverse_name is None: - raise ValueError("Invalid value for 'reverse_name', must not be 'None'") - # Field is required - if reverse_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reverse_name', must not be 'Unset'") - self._reverse_name = reverse_name - - @property - def target_table_guid(self) -> "str": - """Gets the target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Returns - ------- - str - The target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - return self._target_table_guid - - @target_table_guid.setter - def target_table_guid(self, target_table_guid: "str") -> None: - """Sets the target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - - Parameters - ---------- - target_table_guid: str - The target_table_guid of this GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if target_table_guid is None: - raise ValueError("Invalid value for 'target_table_guid', must not be 'None'") - # Field is required - if target_table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_table_guid', must not be 'Unset'") - self._target_table_guid = target_table_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py deleted file mode 100644 index 4535ff3c5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_reverse_name_not_provided_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaReverseNameNotProvidedRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.REVERSENAMENOTPROVIDED, - ) -> None: - """GsaReverseNameNotProvidedRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaReverseNameNotProvidedRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_role_not_provided_permission_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_role_not_provided_permission_error_detail.py deleted file mode 100644 index 52ea8c9f6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_role_not_provided_permission_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_detail import ( # noqa: F401 - GsaPermissionErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_error_reason import ( - GsaPermissionErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRoleNotProvidedPermissionErrorDetail(GsaPermissionErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaPermissionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaPermissionErrorReason" = GsaPermissionErrorReason.ROLENOTPROVIDED, - ) -> None: - """GsaRoleNotProvidedPermissionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaPermissionErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRoleNotProvidedPermissionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_folder_move_error_detail.py deleted file mode 100644 index 387f258d6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_folder_move_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRootFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.ROOT, - ) -> None: - """GsaRootFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRootFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_record_not_available_to_rename_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_record_not_available_to_rename_error_detail.py deleted file mode 100644 index 0821b10c5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_root_record_not_available_to_rename_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRootRecordNotAvailableToRenameErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - "table_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_name": "tableName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.ROOTRECORDNOTAVAILABLETORENAME, - table_name: "str", - ) -> None: - """GsaRootRecordNotAvailableToRenameErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - table_name: str - """ - super().__init__(message=message, reason=reason) - self._table_name: str - - self.table_name = table_name - - @property - def table_name(self) -> "str": - """Gets the table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - - Returns - ------- - str - The table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - """ - return self._table_name - - @table_name.setter - def table_name(self, table_name: "str") -> None: - """Sets the table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - - Parameters - ---------- - table_name: str - The table_name of this GsaRootRecordNotAvailableToRenameErrorDetail. - """ - # Field is not nullable - if table_name is None: - raise ValueError("Invalid value for 'table_name', must not be 'None'") - # Field is required - if table_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_name', must not be 'Unset'") - self._table_name = table_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRootRecordNotAvailableToRenameErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_rule_engine.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_rule_engine.py deleted file mode 100644 index 60051fb23..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_rule_engine.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaRuleEngine(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "fully_qualified_type_name": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "fully_qualified_type_name": "fullyQualifiedTypeName", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - fully_qualified_type_name: "str", - name: "str", - ) -> None: - """GsaRuleEngine - a model defined in Swagger - - Parameters - ---------- - fully_qualified_type_name: str - name: str - """ - self._name: str - self._fully_qualified_type_name: str - - self.name = name - self.fully_qualified_type_name = fully_qualified_type_name - - @property - def name(self) -> "str": - """Gets the name of this GsaRuleEngine. - The name of the rule engine. - - Returns - ------- - str - The name of this GsaRuleEngine. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaRuleEngine. - The name of the rule engine. - - Parameters - ---------- - name: str - The name of this GsaRuleEngine. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def fully_qualified_type_name(self) -> "str": - """Gets the fully_qualified_type_name of this GsaRuleEngine. - The fully qualified name of the rule engine implementation. - - Returns - ------- - str - The fully_qualified_type_name of this GsaRuleEngine. - """ - return self._fully_qualified_type_name - - @fully_qualified_type_name.setter - def fully_qualified_type_name(self, fully_qualified_type_name: "str") -> None: - """Sets the fully_qualified_type_name of this GsaRuleEngine. - The fully qualified name of the rule engine implementation. - - Parameters - ---------- - fully_qualified_type_name: str - The fully_qualified_type_name of this GsaRuleEngine. - """ - # Field is not nullable - if fully_qualified_type_name is None: - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'None'") - # Field is required - if fully_qualified_type_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'Unset'") - self._fully_qualified_type_name = fully_qualified_type_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaRuleEngine): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_file_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_file_move_error_detail.py deleted file mode 100644 index 629620860..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_file_move_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_detail import ( # noqa: F401 - GsaFileMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_file_move_error_reason import ( - GsaFileMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSameParentFileMoveErrorDetail(GsaFileMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFileMoveErrorReason", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFileMoveErrorReason" = GsaFileMoveErrorReason.SAMEPARENT, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaSameParentFileMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFileMoveErrorReason - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFileMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSameParentFileMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_folder_move_error_detail.py deleted file mode 100644 index 446d36eed..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_same_parent_folder_move_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSameParentFolderMoveErrorDetail(GsaFolderMoveErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", - "new_parent_folder_guid": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "new_parent_folder_guid": "newParentFolderGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.SAMEPARENT, - new_parent_folder_guid: "str | Unset_Type" = Unset, - ) -> None: - """GsaSameParentFolderMoveErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderMoveErrorReason - new_parent_folder_guid: str, optional - """ - super().__init__(message=message, reason=reason) - self._new_parent_folder_guid: str | Unset_Type = Unset - - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid - - @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - - Returns - ------- - str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - """ - return self._new_parent_folder_guid - - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - - Parameters - ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaSameParentFolderMoveErrorDetail. - """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSameParentFolderMoveErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_save_search_request.py similarity index 65% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_response.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_save_search_request.py index c28851447..ba636a0ad 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_error_response.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_save_search_request.py @@ -42,7 +42,7 @@ from . import * -class GsaErrorResponse(ModelBase): +class GsaSaveSearchRequest(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,17 +61,17 @@ class GsaErrorResponse(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "message": "str", + "detail": "GsaSearchDetail", + "search_config": "str", } attribute_map: dict[str, str] = { - "code": "code", - "message": "message", + "detail": "detail", + "search_config": "searchConfig", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "detail": "GsaSearchDetail", } discriminator: Optional[str] = None @@ -79,70 +79,70 @@ class GsaErrorResponse(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, + detail: "GsaSearchDetail | Unset_Type" = Unset, + search_config: "str | None | Unset_Type" = Unset, ) -> None: - """GsaErrorResponse - a model defined in Swagger + """GsaSaveSearchRequest - a model defined in Swagger Parameters ---------- - code: GsaErrorCode, optional - message: str | None, optional + detail: GsaSearchDetail, optional + search_config: str | None, optional """ - self._code: GsaErrorCode | Unset_Type = Unset - self._message: str | None | Unset_Type = Unset + self._search_config: str | None | Unset_Type = Unset + self._detail: GsaSearchDetail | Unset_Type = Unset - if code is not Unset: - self.code = code - if message is not Unset: - self.message = message + if search_config is not Unset: + self.search_config = search_config + if detail is not Unset: + self.detail = detail @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaErrorResponse. + def search_config(self) -> "str | None | Unset_Type": + """Gets the search_config of this GsaSaveSearchRequest. Returns ------- - GsaErrorCode | Unset_Type - The code of this GsaErrorResponse. + str | None | Unset_Type + The search_config of this GsaSaveSearchRequest. """ - return self._code + return self._search_config - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaErrorResponse. + @search_config.setter + def search_config(self, search_config: "str | None | Unset_Type") -> None: + """Sets the search_config of this GsaSaveSearchRequest. Parameters ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaErrorResponse. + search_config: str | None | Unset_Type + The search_config of this GsaSaveSearchRequest. """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code + self._search_config = search_config @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaErrorResponse. + def detail(self) -> "GsaSearchDetail | Unset_Type": + """Gets the detail of this GsaSaveSearchRequest. Returns ------- - str | None | Unset_Type - The message of this GsaErrorResponse. + GsaSearchDetail | Unset_Type + The detail of this GsaSaveSearchRequest. """ - return self._message + return self._detail - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaErrorResponse. + @detail.setter + def detail(self, detail: "GsaSearchDetail | Unset_Type") -> None: + """Sets the detail of this GsaSaveSearchRequest. Parameters ---------- - message: str | None | Unset_Type - The message of this GsaErrorResponse. + detail: GsaSearchDetail | Unset_Type + The detail of this GsaSaveSearchRequest. """ - self._message = message + # Field is not nullable + if detail is None: + raise ValueError("Invalid value for 'detail', must not be 'None'") + self._detail = detail @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -166,7 +166,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaErrorResponse): + if not isinstance(other, GsaSaveSearchRequest): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_data_update_server_api_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_detail.py similarity index 63% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_data_update_server_api_request.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_detail.py index 9e29e8f50..967c94de7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_create_data_update_server_api_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_detail.py @@ -42,7 +42,7 @@ from . import * -class GsaCreateDataUpdateServerApiRequest(ModelBase): +class GsaSearchDetail(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,124 +61,141 @@ class GsaCreateDataUpdateServerApiRequest(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "name": "str", - "project": "GsaDataUpdaterProject", + "criteria": "str", "description": "str", + "name": "str", + "notes": "str", } attribute_map: dict[str, str] = { - "name": "name", - "project": "project", + "criteria": "criteria", "description": "description", + "name": "name", + "notes": "notes", } - subtype_mapping: dict[str, str] = { - "project": "GsaDataUpdaterProject", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None def __init__( self, *, - name: "str", - project: "GsaDataUpdaterProject", + criteria: "str | None | Unset_Type" = Unset, description: "str | None | Unset_Type" = Unset, + name: "str | None | Unset_Type" = Unset, + notes: "str | None | Unset_Type" = Unset, ) -> None: - """GsaCreateDataUpdateServerApiRequest - a model defined in Swagger + """GsaSearchDetail - a model defined in Swagger Parameters ---------- - name: str - project: GsaDataUpdaterProject + criteria: str | None, optional description: str | None, optional + name: str | None, optional + notes: str | None, optional """ - self._name: str + self._name: str | None | Unset_Type = Unset self._description: str | None | Unset_Type = Unset - self._project: GsaDataUpdaterProject + self._notes: str | None | Unset_Type = Unset + self._criteria: str | None | Unset_Type = Unset - self.name = name + if name is not Unset: + self.name = name if description is not Unset: self.description = description - self.project = project + if notes is not Unset: + self.notes = notes + if criteria is not Unset: + self.criteria = criteria @property - def name(self) -> "str": - """Gets the name of this GsaCreateDataUpdateServerApiRequest. + def name(self) -> "str | None | Unset_Type": + """Gets the name of this GsaSearchDetail. Returns ------- - str - The name of this GsaCreateDataUpdateServerApiRequest. + str | None | Unset_Type + The name of this GsaSearchDetail. """ return self._name @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaCreateDataUpdateServerApiRequest. + def name(self, name: "str | None | Unset_Type") -> None: + """Sets the name of this GsaSearchDetail. Parameters ---------- - name: str - The name of this GsaCreateDataUpdateServerApiRequest. + name: str | None | Unset_Type + The name of this GsaSearchDetail. """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") self._name = name @property def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaCreateDataUpdateServerApiRequest. + """Gets the description of this GsaSearchDetail. Returns ------- str | None | Unset_Type - The description of this GsaCreateDataUpdateServerApiRequest. + The description of this GsaSearchDetail. """ return self._description @description.setter def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaCreateDataUpdateServerApiRequest. + """Sets the description of this GsaSearchDetail. Parameters ---------- description: str | None | Unset_Type - The description of this GsaCreateDataUpdateServerApiRequest. + The description of this GsaSearchDetail. """ self._description = description @property - def project(self) -> "GsaDataUpdaterProject": - """Gets the project of this GsaCreateDataUpdateServerApiRequest. + def notes(self) -> "str | None | Unset_Type": + """Gets the notes of this GsaSearchDetail. Returns ------- - GsaDataUpdaterProject - The project of this GsaCreateDataUpdateServerApiRequest. + str | None | Unset_Type + The notes of this GsaSearchDetail. + """ + return self._notes + + @notes.setter + def notes(self, notes: "str | None | Unset_Type") -> None: + """Sets the notes of this GsaSearchDetail. + + Parameters + ---------- + notes: str | None | Unset_Type + The notes of this GsaSearchDetail. + """ + self._notes = notes + + @property + def criteria(self) -> "str | None | Unset_Type": + """Gets the criteria of this GsaSearchDetail. + + Returns + ------- + str | None | Unset_Type + The criteria of this GsaSearchDetail. """ - return self._project + return self._criteria - @project.setter - def project(self, project: "GsaDataUpdaterProject") -> None: - """Sets the project of this GsaCreateDataUpdateServerApiRequest. + @criteria.setter + def criteria(self, criteria: "str | None | Unset_Type") -> None: + """Sets the criteria of this GsaSearchDetail. Parameters ---------- - project: GsaDataUpdaterProject - The project of this GsaCreateDataUpdateServerApiRequest. + criteria: str | None | Unset_Type + The criteria of this GsaSearchDetail. """ - # Field is not nullable - if project is None: - raise ValueError("Invalid value for 'project', must not be 'None'") - # Field is required - if project is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'project', must not be 'Unset'") - self._project = project + self._criteria = criteria @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -202,7 +219,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaCreateDataUpdateServerApiRequest): + if not isinstance(other, GsaSearchDetail): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask.py deleted file mode 100644 index ac3393dbf..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask.py +++ /dev/null @@ -1,273 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchMask(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "attributes": "list[GsaAttribute]", - "description": "str", - "record_properties": "list[GsaRecordProperty]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "attributes": "attributes", - "description": "description", - "record_properties": "recordProperties", - } - - subtype_mapping: dict[str, str] = { - "attributes": "GsaAttribute", - "recordProperties": "GsaRecordProperty", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - attributes: "list[GsaAttribute] | None | Unset_Type" = Unset, - description: "str | None | Unset_Type" = Unset, - record_properties: "list[GsaRecordProperty] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchMask - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - attributes: list[GsaAttribute] | None, optional - description: str | None, optional - record_properties: list[GsaRecordProperty] | None, optional - """ - self._attributes: list[GsaAttribute] | None | Unset_Type = Unset - self._record_properties: list[GsaRecordProperty] | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._name: str - self._guid: str - - if attributes is not Unset: - self.attributes = attributes - if record_properties is not Unset: - self.record_properties = record_properties - if description is not Unset: - self.description = description - self.name = name - self.guid = guid - - @property - def attributes(self) -> "list[GsaAttribute] | None | Unset_Type": - """Gets the attributes of this GsaSearchMask. - - Returns - ------- - list[GsaAttribute] | None | Unset_Type - The attributes of this GsaSearchMask. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[GsaAttribute] | None | Unset_Type") -> None: - """Sets the attributes of this GsaSearchMask. - - Parameters - ---------- - attributes: list[GsaAttribute] | None | Unset_Type - The attributes of this GsaSearchMask. - """ - self._attributes = attributes - - @property - def record_properties(self) -> "list[GsaRecordProperty] | None | Unset_Type": - """Gets the record_properties of this GsaSearchMask. - - Returns - ------- - list[GsaRecordProperty] | None | Unset_Type - The record_properties of this GsaSearchMask. - """ - return self._record_properties - - @record_properties.setter - def record_properties( - self, record_properties: "list[GsaRecordProperty] | None | Unset_Type" - ) -> None: - """Sets the record_properties of this GsaSearchMask. - - Parameters - ---------- - record_properties: list[GsaRecordProperty] | None | Unset_Type - The record_properties of this GsaSearchMask. - """ - self._record_properties = record_properties - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSearchMask. - - Returns - ------- - str | None | Unset_Type - The description of this GsaSearchMask. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSearchMask. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaSearchMask. - """ - self._description = description - - @property - def name(self) -> "str": - """Gets the name of this GsaSearchMask. - - Returns - ------- - str - The name of this GsaSearchMask. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSearchMask. - - Parameters - ---------- - name: str - The name of this GsaSearchMask. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSearchMask. - - Returns - ------- - str - The guid of this GsaSearchMask. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSearchMask. - - Parameters - ---------- - guid: str - The guid of this GsaSearchMask. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchMask): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask_info.py deleted file mode 100644 index 87f7a2cc1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_mask_info.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchMaskInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "search_masks": "list[GsaSlimSearchMask]", - } - - attribute_map: dict[str, str] = { - "search_masks": "searchMasks", - } - - subtype_mapping: dict[str, str] = { - "searchMasks": "GsaSlimSearchMask", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - search_masks: "list[GsaSlimSearchMask] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchMaskInfo - a model defined in Swagger - - Parameters - ---------- - search_masks: list[GsaSlimSearchMask] | None, optional - """ - self._search_masks: list[GsaSlimSearchMask] | None | Unset_Type = Unset - - if search_masks is not Unset: - self.search_masks = search_masks - - @property - def search_masks(self) -> "list[GsaSlimSearchMask] | None | Unset_Type": - """Gets the search_masks of this GsaSearchMaskInfo. - - Returns - ------- - list[GsaSlimSearchMask] | None | Unset_Type - The search_masks of this GsaSearchMaskInfo. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[GsaSlimSearchMask] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaSearchMaskInfo. - - Parameters - ---------- - search_masks: list[GsaSlimSearchMask] | None | Unset_Type - The search_masks of this GsaSearchMaskInfo. - """ - self._search_masks = search_masks - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchMaskInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_request.py index 27c3b2a2a..494c84ca7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_request.py @@ -62,25 +62,20 @@ class GsaSearchRequest(ModelBase): """ swagger_types: dict[str, str] = { "criterion": "GsaCriterion", - "find_similar_id": "str", "paging_options": "GsaPagingOptions", "sort_criteria": "list[GsaSortCriterion]", - "table_search_behaviour": "GsaTableSearchBehaviour", } attribute_map: dict[str, str] = { "criterion": "criterion", - "find_similar_id": "findSimilarId", "paging_options": "pagingOptions", "sort_criteria": "sortCriteria", - "table_search_behaviour": "tableSearchBehaviour", } subtype_mapping: dict[str, str] = { "criterion": "GsaCriterion", "sortCriteria": "GsaSortCriterion", "pagingOptions": "GsaPagingOptions", - "tableSearchBehaviour": "GsaTableSearchBehaviour", } discriminator: Optional[str] = None @@ -89,26 +84,20 @@ def __init__( self, *, criterion: "GsaCriterion | Unset_Type" = Unset, - find_similar_id: "str | None | Unset_Type" = Unset, paging_options: "GsaPagingOptions | Unset_Type" = Unset, sort_criteria: "list[GsaSortCriterion] | None | Unset_Type" = Unset, - table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" = Unset, ) -> None: """GsaSearchRequest - a model defined in Swagger Parameters ---------- criterion: GsaCriterion, optional - find_similar_id: str | None, optional paging_options: GsaPagingOptions, optional sort_criteria: list[GsaSortCriterion] | None, optional - table_search_behaviour: GsaTableSearchBehaviour, optional """ self._criterion: GsaCriterion | Unset_Type = Unset self._sort_criteria: list[GsaSortCriterion] | None | Unset_Type = Unset self._paging_options: GsaPagingOptions | Unset_Type = Unset - self._table_search_behaviour: GsaTableSearchBehaviour | Unset_Type = Unset - self._find_similar_id: str | None | Unset_Type = Unset if criterion is not Unset: self.criterion = criterion @@ -116,10 +105,6 @@ def __init__( self.sort_criteria = sort_criteria if paging_options is not Unset: self.paging_options = paging_options - if table_search_behaviour is not Unset: - self.table_search_behaviour = table_search_behaviour - if find_similar_id is not Unset: - self.find_similar_id = find_similar_id @property def criterion(self) -> "GsaCriterion | Unset_Type": @@ -195,57 +180,6 @@ def paging_options(self, paging_options: "GsaPagingOptions | Unset_Type") -> Non raise ValueError("Invalid value for 'paging_options', must not be 'None'") self._paging_options = paging_options - @property - def table_search_behaviour(self) -> "GsaTableSearchBehaviour | Unset_Type": - """Gets the table_search_behaviour of this GsaSearchRequest. - - Returns - ------- - GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaSearchRequest. - """ - return self._table_search_behaviour - - @table_search_behaviour.setter - def table_search_behaviour( - self, table_search_behaviour: "GsaTableSearchBehaviour | Unset_Type" - ) -> None: - """Sets the table_search_behaviour of this GsaSearchRequest. - - Parameters - ---------- - table_search_behaviour: GsaTableSearchBehaviour | Unset_Type - The table_search_behaviour of this GsaSearchRequest. - """ - # Field is not nullable - if table_search_behaviour is None: - raise ValueError("Invalid value for 'table_search_behaviour', must not be 'None'") - self._table_search_behaviour = table_search_behaviour - - @property - def find_similar_id(self) -> "str | None | Unset_Type": - """Gets the find_similar_id of this GsaSearchRequest. - An optional identifier of a find similar calculation to include in this search. Results will include a similarity score. - - Returns - ------- - str | None | Unset_Type - The find_similar_id of this GsaSearchRequest. - """ - return self._find_similar_id - - @find_similar_id.setter - def find_similar_id(self, find_similar_id: "str | None | Unset_Type") -> None: - """Sets the find_similar_id of this GsaSearchRequest. - An optional identifier of a find similar calculation to include in this search. Results will include a similarity score. - - Parameters - ---------- - find_similar_id: str | None | Unset_Type - The find_similar_id of this GsaSearchRequest. - """ - self._find_similar_id = find_similar_id - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_result.py index 4473f20f0..c222c560c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_result.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_result.py @@ -69,7 +69,6 @@ class GsaSearchResult(ModelBase): "record_history_guid": "str", "record_name": "str", "score": "float", - "similarity_score": "float", "sorting_value": "GsaSortingValue", "table_guid": "str", "table_identity": "int", @@ -88,7 +87,6 @@ class GsaSearchResult(ModelBase): "record_history_guid": "recordHistoryGuid", "record_name": "recordName", "score": "score", - "similarity_score": "similarityScore", "sorting_value": "sortingValue", "table_guid": "tableGuid", "table_identity": "tableIdentity", @@ -116,7 +114,6 @@ def __init__( record_history_guid: "str | Unset_Type" = Unset, record_name: "str | None | Unset_Type" = Unset, score: "float | None | Unset_Type" = Unset, - similarity_score: "float | None | Unset_Type" = Unset, sorting_value: "GsaSortingValue | Unset_Type" = Unset, table_guid: "str | Unset_Type" = Unset, table_identity: "int | Unset_Type" = Unset, @@ -137,7 +134,6 @@ def __init__( record_history_guid: str, optional record_name: str | None, optional score: float | None, optional - similarity_score: float | None, optional sorting_value: GsaSortingValue, optional table_guid: str, optional table_identity: int, optional @@ -160,7 +156,6 @@ def __init__( self._parent_guid: str | None | Unset_Type = Unset self._type: GsaRecordType | Unset_Type = Unset self._score: float | None | Unset_Type = Unset - self._similarity_score: float | None | Unset_Type = Unset self._sorting_value: GsaSortingValue | Unset_Type = Unset self.database_key = database_key @@ -190,8 +185,6 @@ def __init__( self.type = type if score is not Unset: self.score = score - if similarity_score is not Unset: - self.similarity_score = similarity_score if sorting_value is not Unset: self.sorting_value = sorting_value @@ -527,28 +520,6 @@ def score(self, score: "float | None | Unset_Type") -> None: """ self._score = score - @property - def similarity_score(self) -> "float | None | Unset_Type": - """Gets the similarity_score of this GsaSearchResult. - - Returns - ------- - float | None | Unset_Type - The similarity_score of this GsaSearchResult. - """ - return self._similarity_score - - @similarity_score.setter - def similarity_score(self, similarity_score: "float | None | Unset_Type") -> None: - """Sets the similarity_score of this GsaSearchResult. - - Parameters - ---------- - similarity_score: float | None | Unset_Type - The similarity_score of this GsaSearchResult. - """ - self._similarity_score = similarity_score - @property def sorting_value(self) -> "GsaSortingValue | Unset_Type": """Gets the sorting_value of this GsaSearchResult. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_service_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_service_status.py deleted file mode 100644 index 71743e849..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_service_status.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchServiceStatus(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_running": "bool", - } - - attribute_map: dict[str, str] = { - "is_running": "isRunning", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_running: "bool", - ) -> None: - """GsaSearchServiceStatus - a model defined in Swagger - - Parameters - ---------- - is_running: bool - """ - self._is_running: bool - - self.is_running = is_running - - @property - def is_running(self) -> "bool": - """Gets the is_running of this GsaSearchServiceStatus. - - Returns - ------- - bool - The is_running of this GsaSearchServiceStatus. - """ - return self._is_running - - @is_running.setter - def is_running(self, is_running: "bool") -> None: - """Sets the is_running of this GsaSearchServiceStatus. - - Parameters - ---------- - is_running: bool - The is_running of this GsaSearchServiceStatus. - """ - # Field is not nullable - if is_running is None: - raise ValueError("Invalid value for 'is_running', must not be 'None'") - # Field is required - if is_running is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_running', must not be 'Unset'") - self._is_running = is_running - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchServiceStatus): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template.py deleted file mode 100644 index 294b90308..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template.py +++ /dev/null @@ -1,278 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "table": "GsaSlimEntity", - "description": "str", - "search_attributes": "list[GsaSearchTemplateItem]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "table": "table", - "description": "description", - "search_attributes": "searchAttributes", - } - - subtype_mapping: dict[str, str] = { - "searchAttributes": "GsaSearchTemplateItem", - "table": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - table: "GsaSlimEntity", - description: "str | None | Unset_Type" = Unset, - search_attributes: "list[GsaSearchTemplateItem] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplate - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - table: GsaSlimEntity - description: str | None, optional - search_attributes: list[GsaSearchTemplateItem] | None, optional - """ - self._search_attributes: list[GsaSearchTemplateItem] | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._table: GsaSlimEntity - self._name: str - self._guid: str - - if search_attributes is not Unset: - self.search_attributes = search_attributes - if description is not Unset: - self.description = description - self.table = table - self.name = name - self.guid = guid - - @property - def search_attributes(self) -> "list[GsaSearchTemplateItem] | None | Unset_Type": - """Gets the search_attributes of this GsaSearchTemplate. - - Returns - ------- - list[GsaSearchTemplateItem] | None | Unset_Type - The search_attributes of this GsaSearchTemplate. - """ - return self._search_attributes - - @search_attributes.setter - def search_attributes( - self, search_attributes: "list[GsaSearchTemplateItem] | None | Unset_Type" - ) -> None: - """Sets the search_attributes of this GsaSearchTemplate. - - Parameters - ---------- - search_attributes: list[GsaSearchTemplateItem] | None | Unset_Type - The search_attributes of this GsaSearchTemplate. - """ - self._search_attributes = search_attributes - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSearchTemplate. - - Returns - ------- - str | None | Unset_Type - The description of this GsaSearchTemplate. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSearchTemplate. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaSearchTemplate. - """ - self._description = description - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSearchTemplate. - - Returns - ------- - GsaSlimEntity - The table of this GsaSearchTemplate. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSearchTemplate. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSearchTemplate. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def name(self) -> "str": - """Gets the name of this GsaSearchTemplate. - - Returns - ------- - str - The name of this GsaSearchTemplate. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSearchTemplate. - - Parameters - ---------- - name: str - The name of this GsaSearchTemplate. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSearchTemplate. - - Returns - ------- - str - The guid of this GsaSearchTemplate. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSearchTemplate. - - Parameters - ---------- - guid: str - The guid of this GsaSearchTemplate. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_attribute_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_attribute_item.py deleted file mode 100644 index 19a89bc3d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_attribute_item.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateAttributeItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.ATTRIBUTE, - ) -> None: - """GsaSearchTemplateAttributeItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - """ - super().__init__(attribute=attribute, item_type=item_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateAttributeItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_info.py deleted file mode 100644 index ca0baf336..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "search_templates": "list[GsaSlimSearchTemplate]", - } - - attribute_map: dict[str, str] = { - "search_templates": "searchTemplates", - } - - subtype_mapping: dict[str, str] = { - "searchTemplates": "GsaSlimSearchTemplate", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - search_templates: "list[GsaSlimSearchTemplate] | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplateInfo - a model defined in Swagger - - Parameters - ---------- - search_templates: list[GsaSlimSearchTemplate] | None, optional - """ - self._search_templates: list[GsaSlimSearchTemplate] | None | Unset_Type = Unset - - if search_templates is not Unset: - self.search_templates = search_templates - - @property - def search_templates(self) -> "list[GsaSlimSearchTemplate] | None | Unset_Type": - """Gets the search_templates of this GsaSearchTemplateInfo. - - Returns - ------- - list[GsaSlimSearchTemplate] | None | Unset_Type - The search_templates of this GsaSearchTemplateInfo. - """ - return self._search_templates - - @search_templates.setter - def search_templates( - self, search_templates: "list[GsaSlimSearchTemplate] | None | Unset_Type" - ) -> None: - """Sets the search_templates of this GsaSearchTemplateInfo. - - Parameters - ---------- - search_templates: list[GsaSlimSearchTemplate] | None | Unset_Type - The search_templates of this GsaSearchTemplateInfo. - """ - self._search_templates = search_templates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item.py deleted file mode 100644 index cbb918be7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaSearchTemplateItemType", - "attribute": "GsaSlimEntity", - } - - discriminator_value_class_map = { - "attribute".lower(): "#/components/schemas/GsaSearchTemplateAttributeItem", - "tabularColumn".lower(): "#/components/schemas/GsaSearchTemplateTabularColumnItem", - "link".lower(): "#/components/schemas/GsaSearchTemplateLinkItem", - } - - discriminator: Optional[str] = "itemType" - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType", - ) -> None: - """GsaSearchTemplateItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - """ - self._item_type: GsaSearchTemplateItemType - self._attribute: GsaSlimEntity - - self.item_type = item_type - self.attribute = attribute - - @property - def item_type(self) -> "GsaSearchTemplateItemType": - """Gets the item_type of this GsaSearchTemplateItem. - - Returns - ------- - GsaSearchTemplateItemType - The item_type of this GsaSearchTemplateItem. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaSearchTemplateItemType") -> None: - """Sets the item_type of this GsaSearchTemplateItem. - - Parameters - ---------- - item_type: GsaSearchTemplateItemType - The item_type of this GsaSearchTemplateItem. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaSearchTemplateItem. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaSearchTemplateItem. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaSearchTemplateItem. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaSearchTemplateItem. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item_type.py deleted file mode 100644 index 03cdaf40f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_item_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaSearchTemplateItemType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTE = "attribute" - TABULARCOLUMN = "tabularColumn" - LINK = "link" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_link_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_link_item.py deleted file mode 100644 index c126556e5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_link_item.py +++ /dev/null @@ -1,267 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateLinkItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "forwards": "bool", - "item_type": "GsaSearchTemplateItemType", - "link_type": "GsaRecordLinkGroupType", - "record_link_group": "GsaSlimEntity", - "target_database": "str", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "forwards": "forwards", - "item_type": "itemType", - "link_type": "linkType", - "record_link_group": "recordLinkGroup", - "target_database": "targetDatabase", - } - - subtype_mapping: dict[str, str] = { - "recordLinkGroup": "GsaSlimEntity", - "linkType": "GsaRecordLinkGroupType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - forwards: "bool", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.LINK, - link_type: "GsaRecordLinkGroupType", - record_link_group: "GsaSlimEntity", - target_database: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSearchTemplateLinkItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - forwards: bool - item_type: GsaSearchTemplateItemType - link_type: GsaRecordLinkGroupType - record_link_group: GsaSlimEntity - target_database: str | None, optional - """ - super().__init__(attribute=attribute, item_type=item_type) - self._record_link_group: GsaSlimEntity - self._link_type: GsaRecordLinkGroupType - self._target_database: str | None | Unset_Type = Unset - self._forwards: bool - - self.record_link_group = record_link_group - self.link_type = link_type - if target_database is not Unset: - self.target_database = target_database - self.forwards = forwards - - @property - def record_link_group(self) -> "GsaSlimEntity": - """Gets the record_link_group of this GsaSearchTemplateLinkItem. - - Returns - ------- - GsaSlimEntity - The record_link_group of this GsaSearchTemplateLinkItem. - """ - return self._record_link_group - - @record_link_group.setter - def record_link_group(self, record_link_group: "GsaSlimEntity") -> None: - """Sets the record_link_group of this GsaSearchTemplateLinkItem. - - Parameters - ---------- - record_link_group: GsaSlimEntity - The record_link_group of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if record_link_group is None: - raise ValueError("Invalid value for 'record_link_group', must not be 'None'") - # Field is required - if record_link_group is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'record_link_group', must not be 'Unset'") - self._record_link_group = record_link_group - - @property - def link_type(self) -> "GsaRecordLinkGroupType": - """Gets the link_type of this GsaSearchTemplateLinkItem. - - Returns - ------- - GsaRecordLinkGroupType - The link_type of this GsaSearchTemplateLinkItem. - """ - return self._link_type - - @link_type.setter - def link_type(self, link_type: "GsaRecordLinkGroupType") -> None: - """Sets the link_type of this GsaSearchTemplateLinkItem. - - Parameters - ---------- - link_type: GsaRecordLinkGroupType - The link_type of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if link_type is None: - raise ValueError("Invalid value for 'link_type', must not be 'None'") - # Field is required - if link_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_type', must not be 'Unset'") - self._link_type = link_type - - @property - def target_database(self) -> "str | None | Unset_Type": - """Gets the target_database of this GsaSearchTemplateLinkItem. - May be null for a static link group, or a cross database link group that can target multiple databases - - Returns - ------- - str | None | Unset_Type - The target_database of this GsaSearchTemplateLinkItem. - """ - return self._target_database - - @target_database.setter - def target_database(self, target_database: "str | None | Unset_Type") -> None: - """Sets the target_database of this GsaSearchTemplateLinkItem. - May be null for a static link group, or a cross database link group that can target multiple databases - - Parameters - ---------- - target_database: str | None | Unset_Type - The target_database of this GsaSearchTemplateLinkItem. - """ - self._target_database = target_database - - @property - def forwards(self) -> "bool": - """Gets the forwards of this GsaSearchTemplateLinkItem. - true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link). - - Returns - ------- - bool - The forwards of this GsaSearchTemplateLinkItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool") -> None: - """Sets the forwards of this GsaSearchTemplateLinkItem. - true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link). - - Parameters - ---------- - forwards: bool - The forwards of this GsaSearchTemplateLinkItem. - """ - # Field is not nullable - if forwards is None: - raise ValueError("Invalid value for 'forwards', must not be 'None'") - # Field is required - if forwards is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'forwards', must not be 'Unset'") - self._forwards = forwards - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateLinkItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_tabular_column_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_tabular_column_item.py deleted file mode 100644 index cfd8861b0..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_search_template_tabular_column_item.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item import ( # noqa: F401 - GsaSearchTemplateItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_search_template_item_type import ( - GsaSearchTemplateItemType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSearchTemplateTabularColumnItem(GsaSearchTemplateItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "item_type": "GsaSearchTemplateItemType", - "tabular_column": "GsaTabularColumn", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "item_type": "itemType", - "tabular_column": "tabularColumn", - } - - subtype_mapping: dict[str, str] = { - "tabularColumn": "GsaTabularColumn", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - item_type: "GsaSearchTemplateItemType" = GsaSearchTemplateItemType.TABULARCOLUMN, - tabular_column: "GsaTabularColumn", - ) -> None: - """GsaSearchTemplateTabularColumnItem - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - item_type: GsaSearchTemplateItemType - tabular_column: GsaTabularColumn - """ - super().__init__(attribute=attribute, item_type=item_type) - self._tabular_column: GsaTabularColumn - - self.tabular_column = tabular_column - - @property - def tabular_column(self) -> "GsaTabularColumn": - """Gets the tabular_column of this GsaSearchTemplateTabularColumnItem. - - Returns - ------- - GsaTabularColumn - The tabular_column of this GsaSearchTemplateTabularColumnItem. - """ - return self._tabular_column - - @tabular_column.setter - def tabular_column(self, tabular_column: "GsaTabularColumn") -> None: - """Sets the tabular_column of this GsaSearchTemplateTabularColumnItem. - - Parameters - ---------- - tabular_column: GsaTabularColumn - The tabular_column of this GsaSearchTemplateTabularColumnItem. - """ - # Field is not nullable - if tabular_column is None: - raise ValueError("Invalid value for 'tabular_column', must not be 'None'") - # Field is required - if tabular_column is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'tabular_column', must not be 'Unset'") - self._tabular_column = tabular_column - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSearchTemplateTabularColumnItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_already_exists_folder_move_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_security_attribute_grouping.py similarity index 58% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_already_exists_folder_move_error_detail.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_security_attribute_grouping.py index 046007e24..d1d1410a2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_folder_already_exists_folder_move_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_security_attribute_grouping.py @@ -33,13 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_detail import ( # noqa: F401 - GsaFolderMoveErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_move_error_reason import ( - GsaFolderMoveErrorReason, -) - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -49,7 +42,7 @@ from . import * -class GsaFolderAlreadyExistsFolderMoveErrorDetail(GsaFolderMoveErrorDetail): +class GsaSecurityAttributeGrouping(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -68,95 +61,119 @@ class GsaFolderAlreadyExistsFolderMoveErrorDetail(GsaFolderMoveErrorDetail): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderMoveErrorReason", + "available_discrete_values": "list[GsaDiscreteValue]", + "identity": "int", "name": "str", - "new_parent_folder_guid": "str", } attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", + "available_discrete_values": "availableDiscreteValues", + "identity": "identity", "name": "name", - "new_parent_folder_guid": "newParentFolderGuid", } - subtype_mapping: dict[str, str] = {} + subtype_mapping: dict[str, str] = { + "availableDiscreteValues": "GsaDiscreteValue", + } discriminator: Optional[str] = None def __init__( self, *, - message: "str", - reason: "GsaFolderMoveErrorReason" = GsaFolderMoveErrorReason.FOLDERALREADYEXISTS, + available_discrete_values: "list[GsaDiscreteValue] | None | Unset_Type" = Unset, + identity: "int | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - new_parent_folder_guid: "str | Unset_Type" = Unset, ) -> None: - """GsaFolderAlreadyExistsFolderMoveErrorDetail - a model defined in Swagger + """GsaSecurityAttributeGrouping - a model defined in Swagger Parameters ---------- - message: str - reason: GsaFolderMoveErrorReason + available_discrete_values: list[GsaDiscreteValue] | None, optional + identity: int, optional name: str | None, optional - new_parent_folder_guid: str, optional """ - super().__init__(message=message, reason=reason) + self._identity: int | Unset_Type = Unset self._name: str | None | Unset_Type = Unset - self._new_parent_folder_guid: str | Unset_Type = Unset + self._available_discrete_values: list[GsaDiscreteValue] | None | Unset_Type = Unset + if identity is not Unset: + self.identity = identity if name is not Unset: self.name = name - if new_parent_folder_guid is not Unset: - self.new_parent_folder_guid = new_parent_folder_guid + if available_discrete_values is not Unset: + self.available_discrete_values = available_discrete_values + + @property + def identity(self) -> "int | Unset_Type": + """Gets the identity of this GsaSecurityAttributeGrouping. + + Returns + ------- + int | Unset_Type + The identity of this GsaSecurityAttributeGrouping. + """ + return self._identity + + @identity.setter + def identity(self, identity: "int | Unset_Type") -> None: + """Sets the identity of this GsaSecurityAttributeGrouping. + + Parameters + ---------- + identity: int | Unset_Type + The identity of this GsaSecurityAttributeGrouping. + """ + # Field is not nullable + if identity is None: + raise ValueError("Invalid value for 'identity', must not be 'None'") + self._identity = identity @property def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + """Gets the name of this GsaSecurityAttributeGrouping. Returns ------- str | None | Unset_Type - The name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + The name of this GsaSecurityAttributeGrouping. """ return self._name @name.setter def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + """Sets the name of this GsaSecurityAttributeGrouping. Parameters ---------- name: str | None | Unset_Type - The name of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + The name of this GsaSecurityAttributeGrouping. """ self._name = name @property - def new_parent_folder_guid(self) -> "str | Unset_Type": - """Gets the new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + def available_discrete_values(self) -> "list[GsaDiscreteValue] | None | Unset_Type": + """Gets the available_discrete_values of this GsaSecurityAttributeGrouping. Returns ------- - str | Unset_Type - The new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + list[GsaDiscreteValue] | None | Unset_Type + The available_discrete_values of this GsaSecurityAttributeGrouping. """ - return self._new_parent_folder_guid + return self._available_discrete_values - @new_parent_folder_guid.setter - def new_parent_folder_guid(self, new_parent_folder_guid: "str | Unset_Type") -> None: - """Sets the new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + @available_discrete_values.setter + def available_discrete_values( + self, available_discrete_values: "list[GsaDiscreteValue] | None | Unset_Type" + ) -> None: + """Sets the available_discrete_values of this GsaSecurityAttributeGrouping. Parameters ---------- - new_parent_folder_guid: str | Unset_Type - The new_parent_folder_guid of this GsaFolderAlreadyExistsFolderMoveErrorDetail. + available_discrete_values: list[GsaDiscreteValue] | None | Unset_Type + The available_discrete_values of this GsaSecurityAttributeGrouping. """ - # Field is not nullable - if new_parent_folder_guid is None: - raise ValueError("Invalid value for 'new_parent_folder_guid', must not be 'None'") - self._new_parent_folder_guid = new_parent_folder_guid + self._available_discrete_values = available_discrete_values @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -180,7 +197,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaFolderAlreadyExistsFolderMoveErrorDetail): + if not isinstance(other, GsaSecurityAttributeGrouping): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection.py deleted file mode 100644 index 29411749f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection.py +++ /dev/null @@ -1,643 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSelection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_guids": "list[str]", - "constant_guids": "list[str]", - "cross_database_link_group_guids": "list[str]", - "discrete_type_guids": "list[str]", - "dynamic_link_group_guids": "list[str]", - "file_guids": "list[str]", - "layout_guids": "list[str]", - "parameter_guids": "list[str]", - "record_guids": "list[str]", - "record_linked_group_guids": "list[str]", - "replacement_string_guids": "list[str]", - "search_mask_guids": "list[str]", - "search_template_guids": "list[str]", - "standard_name_guids": "list[str]", - "subset_guids": "list[str]", - "table_guids": "list[str]", - "unit_guids": "list[str]", - "unit_system_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "attribute_guids": "attributeGuids", - "constant_guids": "constantGuids", - "cross_database_link_group_guids": "crossDatabaseLinkGroupGuids", - "discrete_type_guids": "discreteTypeGuids", - "dynamic_link_group_guids": "dynamicLinkGroupGuids", - "file_guids": "fileGuids", - "layout_guids": "layoutGuids", - "parameter_guids": "parameterGuids", - "record_guids": "recordGuids", - "record_linked_group_guids": "recordLinkedGroupGuids", - "replacement_string_guids": "replacementStringGuids", - "search_mask_guids": "searchMaskGuids", - "search_template_guids": "searchTemplateGuids", - "standard_name_guids": "standardNameGuids", - "subset_guids": "subsetGuids", - "table_guids": "tableGuids", - "unit_guids": "unitGuids", - "unit_system_guids": "unitSystemGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_guids: "list[str] | None | Unset_Type" = Unset, - constant_guids: "list[str] | None | Unset_Type" = Unset, - cross_database_link_group_guids: "list[str] | None | Unset_Type" = Unset, - discrete_type_guids: "list[str] | None | Unset_Type" = Unset, - dynamic_link_group_guids: "list[str] | None | Unset_Type" = Unset, - file_guids: "list[str] | None | Unset_Type" = Unset, - layout_guids: "list[str] | None | Unset_Type" = Unset, - parameter_guids: "list[str] | None | Unset_Type" = Unset, - record_guids: "list[str] | None | Unset_Type" = Unset, - record_linked_group_guids: "list[str] | None | Unset_Type" = Unset, - replacement_string_guids: "list[str] | None | Unset_Type" = Unset, - search_mask_guids: "list[str] | None | Unset_Type" = Unset, - search_template_guids: "list[str] | None | Unset_Type" = Unset, - standard_name_guids: "list[str] | None | Unset_Type" = Unset, - subset_guids: "list[str] | None | Unset_Type" = Unset, - table_guids: "list[str] | None | Unset_Type" = Unset, - unit_guids: "list[str] | None | Unset_Type" = Unset, - unit_system_guids: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaSelection - a model defined in Swagger - - Parameters - ---------- - attribute_guids: list[str] | None, optional - constant_guids: list[str] | None, optional - cross_database_link_group_guids: list[str] | None, optional - discrete_type_guids: list[str] | None, optional - dynamic_link_group_guids: list[str] | None, optional - file_guids: list[str] | None, optional - layout_guids: list[str] | None, optional - parameter_guids: list[str] | None, optional - record_guids: list[str] | None, optional - record_linked_group_guids: list[str] | None, optional - replacement_string_guids: list[str] | None, optional - search_mask_guids: list[str] | None, optional - search_template_guids: list[str] | None, optional - standard_name_guids: list[str] | None, optional - subset_guids: list[str] | None, optional - table_guids: list[str] | None, optional - unit_guids: list[str] | None, optional - unit_system_guids: list[str] | None, optional - """ - self._table_guids: list[str] | None | Unset_Type = Unset - self._attribute_guids: list[str] | None | Unset_Type = Unset - self._record_guids: list[str] | None | Unset_Type = Unset - self._discrete_type_guids: list[str] | None | Unset_Type = Unset - self._parameter_guids: list[str] | None | Unset_Type = Unset - self._layout_guids: list[str] | None | Unset_Type = Unset - self._subset_guids: list[str] | None | Unset_Type = Unset - self._standard_name_guids: list[str] | None | Unset_Type = Unset - self._record_linked_group_guids: list[str] | None | Unset_Type = Unset - self._unit_guids: list[str] | None | Unset_Type = Unset - self._replacement_string_guids: list[str] | None | Unset_Type = Unset - self._constant_guids: list[str] | None | Unset_Type = Unset - self._unit_system_guids: list[str] | None | Unset_Type = Unset - self._file_guids: list[str] | None | Unset_Type = Unset - self._search_mask_guids: list[str] | None | Unset_Type = Unset - self._search_template_guids: list[str] | None | Unset_Type = Unset - self._dynamic_link_group_guids: list[str] | None | Unset_Type = Unset - self._cross_database_link_group_guids: list[str] | None | Unset_Type = Unset - - if table_guids is not Unset: - self.table_guids = table_guids - if attribute_guids is not Unset: - self.attribute_guids = attribute_guids - if record_guids is not Unset: - self.record_guids = record_guids - if discrete_type_guids is not Unset: - self.discrete_type_guids = discrete_type_guids - if parameter_guids is not Unset: - self.parameter_guids = parameter_guids - if layout_guids is not Unset: - self.layout_guids = layout_guids - if subset_guids is not Unset: - self.subset_guids = subset_guids - if standard_name_guids is not Unset: - self.standard_name_guids = standard_name_guids - if record_linked_group_guids is not Unset: - self.record_linked_group_guids = record_linked_group_guids - if unit_guids is not Unset: - self.unit_guids = unit_guids - if replacement_string_guids is not Unset: - self.replacement_string_guids = replacement_string_guids - if constant_guids is not Unset: - self.constant_guids = constant_guids - if unit_system_guids is not Unset: - self.unit_system_guids = unit_system_guids - if file_guids is not Unset: - self.file_guids = file_guids - if search_mask_guids is not Unset: - self.search_mask_guids = search_mask_guids - if search_template_guids is not Unset: - self.search_template_guids = search_template_guids - if dynamic_link_group_guids is not Unset: - self.dynamic_link_group_guids = dynamic_link_group_guids - if cross_database_link_group_guids is not Unset: - self.cross_database_link_group_guids = cross_database_link_group_guids - - @property - def table_guids(self) -> "list[str] | None | Unset_Type": - """Gets the table_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The table_guids of this GsaSelection. - """ - return self._table_guids - - @table_guids.setter - def table_guids(self, table_guids: "list[str] | None | Unset_Type") -> None: - """Sets the table_guids of this GsaSelection. - - Parameters - ---------- - table_guids: list[str] | None | Unset_Type - The table_guids of this GsaSelection. - """ - self._table_guids = table_guids - - @property - def attribute_guids(self) -> "list[str] | None | Unset_Type": - """Gets the attribute_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The attribute_guids of this GsaSelection. - """ - return self._attribute_guids - - @attribute_guids.setter - def attribute_guids(self, attribute_guids: "list[str] | None | Unset_Type") -> None: - """Sets the attribute_guids of this GsaSelection. - - Parameters - ---------- - attribute_guids: list[str] | None | Unset_Type - The attribute_guids of this GsaSelection. - """ - self._attribute_guids = attribute_guids - - @property - def record_guids(self) -> "list[str] | None | Unset_Type": - """Gets the record_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The record_guids of this GsaSelection. - """ - return self._record_guids - - @record_guids.setter - def record_guids(self, record_guids: "list[str] | None | Unset_Type") -> None: - """Sets the record_guids of this GsaSelection. - - Parameters - ---------- - record_guids: list[str] | None | Unset_Type - The record_guids of this GsaSelection. - """ - self._record_guids = record_guids - - @property - def discrete_type_guids(self) -> "list[str] | None | Unset_Type": - """Gets the discrete_type_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The discrete_type_guids of this GsaSelection. - """ - return self._discrete_type_guids - - @discrete_type_guids.setter - def discrete_type_guids(self, discrete_type_guids: "list[str] | None | Unset_Type") -> None: - """Sets the discrete_type_guids of this GsaSelection. - - Parameters - ---------- - discrete_type_guids: list[str] | None | Unset_Type - The discrete_type_guids of this GsaSelection. - """ - self._discrete_type_guids = discrete_type_guids - - @property - def parameter_guids(self) -> "list[str] | None | Unset_Type": - """Gets the parameter_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The parameter_guids of this GsaSelection. - """ - return self._parameter_guids - - @parameter_guids.setter - def parameter_guids(self, parameter_guids: "list[str] | None | Unset_Type") -> None: - """Sets the parameter_guids of this GsaSelection. - - Parameters - ---------- - parameter_guids: list[str] | None | Unset_Type - The parameter_guids of this GsaSelection. - """ - self._parameter_guids = parameter_guids - - @property - def layout_guids(self) -> "list[str] | None | Unset_Type": - """Gets the layout_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The layout_guids of this GsaSelection. - """ - return self._layout_guids - - @layout_guids.setter - def layout_guids(self, layout_guids: "list[str] | None | Unset_Type") -> None: - """Sets the layout_guids of this GsaSelection. - - Parameters - ---------- - layout_guids: list[str] | None | Unset_Type - The layout_guids of this GsaSelection. - """ - self._layout_guids = layout_guids - - @property - def subset_guids(self) -> "list[str] | None | Unset_Type": - """Gets the subset_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The subset_guids of this GsaSelection. - """ - return self._subset_guids - - @subset_guids.setter - def subset_guids(self, subset_guids: "list[str] | None | Unset_Type") -> None: - """Sets the subset_guids of this GsaSelection. - - Parameters - ---------- - subset_guids: list[str] | None | Unset_Type - The subset_guids of this GsaSelection. - """ - self._subset_guids = subset_guids - - @property - def standard_name_guids(self) -> "list[str] | None | Unset_Type": - """Gets the standard_name_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The standard_name_guids of this GsaSelection. - """ - return self._standard_name_guids - - @standard_name_guids.setter - def standard_name_guids(self, standard_name_guids: "list[str] | None | Unset_Type") -> None: - """Sets the standard_name_guids of this GsaSelection. - - Parameters - ---------- - standard_name_guids: list[str] | None | Unset_Type - The standard_name_guids of this GsaSelection. - """ - self._standard_name_guids = standard_name_guids - - @property - def record_linked_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the record_linked_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The record_linked_group_guids of this GsaSelection. - """ - return self._record_linked_group_guids - - @record_linked_group_guids.setter - def record_linked_group_guids( - self, record_linked_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the record_linked_group_guids of this GsaSelection. - - Parameters - ---------- - record_linked_group_guids: list[str] | None | Unset_Type - The record_linked_group_guids of this GsaSelection. - """ - self._record_linked_group_guids = record_linked_group_guids - - @property - def unit_guids(self) -> "list[str] | None | Unset_Type": - """Gets the unit_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The unit_guids of this GsaSelection. - """ - return self._unit_guids - - @unit_guids.setter - def unit_guids(self, unit_guids: "list[str] | None | Unset_Type") -> None: - """Sets the unit_guids of this GsaSelection. - - Parameters - ---------- - unit_guids: list[str] | None | Unset_Type - The unit_guids of this GsaSelection. - """ - self._unit_guids = unit_guids - - @property - def replacement_string_guids(self) -> "list[str] | None | Unset_Type": - """Gets the replacement_string_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The replacement_string_guids of this GsaSelection. - """ - return self._replacement_string_guids - - @replacement_string_guids.setter - def replacement_string_guids( - self, replacement_string_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the replacement_string_guids of this GsaSelection. - - Parameters - ---------- - replacement_string_guids: list[str] | None | Unset_Type - The replacement_string_guids of this GsaSelection. - """ - self._replacement_string_guids = replacement_string_guids - - @property - def constant_guids(self) -> "list[str] | None | Unset_Type": - """Gets the constant_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The constant_guids of this GsaSelection. - """ - return self._constant_guids - - @constant_guids.setter - def constant_guids(self, constant_guids: "list[str] | None | Unset_Type") -> None: - """Sets the constant_guids of this GsaSelection. - - Parameters - ---------- - constant_guids: list[str] | None | Unset_Type - The constant_guids of this GsaSelection. - """ - self._constant_guids = constant_guids - - @property - def unit_system_guids(self) -> "list[str] | None | Unset_Type": - """Gets the unit_system_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The unit_system_guids of this GsaSelection. - """ - return self._unit_system_guids - - @unit_system_guids.setter - def unit_system_guids(self, unit_system_guids: "list[str] | None | Unset_Type") -> None: - """Sets the unit_system_guids of this GsaSelection. - - Parameters - ---------- - unit_system_guids: list[str] | None | Unset_Type - The unit_system_guids of this GsaSelection. - """ - self._unit_system_guids = unit_system_guids - - @property - def file_guids(self) -> "list[str] | None | Unset_Type": - """Gets the file_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The file_guids of this GsaSelection. - """ - return self._file_guids - - @file_guids.setter - def file_guids(self, file_guids: "list[str] | None | Unset_Type") -> None: - """Sets the file_guids of this GsaSelection. - - Parameters - ---------- - file_guids: list[str] | None | Unset_Type - The file_guids of this GsaSelection. - """ - self._file_guids = file_guids - - @property - def search_mask_guids(self) -> "list[str] | None | Unset_Type": - """Gets the search_mask_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The search_mask_guids of this GsaSelection. - """ - return self._search_mask_guids - - @search_mask_guids.setter - def search_mask_guids(self, search_mask_guids: "list[str] | None | Unset_Type") -> None: - """Sets the search_mask_guids of this GsaSelection. - - Parameters - ---------- - search_mask_guids: list[str] | None | Unset_Type - The search_mask_guids of this GsaSelection. - """ - self._search_mask_guids = search_mask_guids - - @property - def search_template_guids(self) -> "list[str] | None | Unset_Type": - """Gets the search_template_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The search_template_guids of this GsaSelection. - """ - return self._search_template_guids - - @search_template_guids.setter - def search_template_guids(self, search_template_guids: "list[str] | None | Unset_Type") -> None: - """Sets the search_template_guids of this GsaSelection. - - Parameters - ---------- - search_template_guids: list[str] | None | Unset_Type - The search_template_guids of this GsaSelection. - """ - self._search_template_guids = search_template_guids - - @property - def dynamic_link_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the dynamic_link_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The dynamic_link_group_guids of this GsaSelection. - """ - return self._dynamic_link_group_guids - - @dynamic_link_group_guids.setter - def dynamic_link_group_guids( - self, dynamic_link_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the dynamic_link_group_guids of this GsaSelection. - - Parameters - ---------- - dynamic_link_group_guids: list[str] | None | Unset_Type - The dynamic_link_group_guids of this GsaSelection. - """ - self._dynamic_link_group_guids = dynamic_link_group_guids - - @property - def cross_database_link_group_guids(self) -> "list[str] | None | Unset_Type": - """Gets the cross_database_link_group_guids of this GsaSelection. - - Returns - ------- - list[str] | None | Unset_Type - The cross_database_link_group_guids of this GsaSelection. - """ - return self._cross_database_link_group_guids - - @cross_database_link_group_guids.setter - def cross_database_link_group_guids( - self, cross_database_link_group_guids: "list[str] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_group_guids of this GsaSelection. - - Parameters - ---------- - cross_database_link_group_guids: list[str] | None | Unset_Type - The cross_database_link_group_guids of this GsaSelection. - """ - self._cross_database_link_group_guids = cross_database_link_group_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSelection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection_search.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection_search.py new file mode 100644 index 000000000..e5da4ee70 --- /dev/null +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_selection_search.py @@ -0,0 +1,454 @@ +# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. +# SPDX-License-Identifier: MIT +# +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +""" +MI Server API + +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + +OpenAPI spec version: v1 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import re # noqa: F401 +from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 + +from . import ModelBase, Unset, Unset_Type + +if TYPE_CHECKING: + from datetime import datetime + import pathlib + + from . import * + + +class GsaSelectionSearch(ModelBase): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes + ---------- + swagger_types: dict[str, str] + The key is attribute name and the value is attribute type. + attribute_map: dict[str, str] + The key is attribute name and the value is json key in definition. + subtype_mapping: dict[str, str] + The key is the unmangled property name and the value is the corresponding type. + discriminator: Optional[str] + Name of the property used as discriminator for subtypes. + """ + swagger_types: dict[str, str] = { + "created_timestamp": "datetime", + "created_user_or_group": "GsaUserOrGroup", + "criteria": "str", + "current_user_access_info": "dict(str, dict(str, bool))", + "description": "str", + "explore_config": "str", + "last_modified_timestamp": "datetime", + "last_modified_user_or_group": "GsaUserOrGroup", + "name": "str", + "notes": "str", + "search_identifier": "str", + } + + attribute_map: dict[str, str] = { + "created_timestamp": "createdTimestamp", + "created_user_or_group": "createdUserOrGroup", + "criteria": "criteria", + "current_user_access_info": "currentUserAccessInfo", + "description": "description", + "explore_config": "exploreConfig", + "last_modified_timestamp": "lastModifiedTimestamp", + "last_modified_user_or_group": "lastModifiedUserOrGroup", + "name": "name", + "notes": "notes", + "search_identifier": "searchIdentifier", + } + + subtype_mapping: dict[str, str] = { + "createdUserOrGroup": "GsaUserOrGroup", + "lastModifiedUserOrGroup": "GsaUserOrGroup", + } + + discriminator: Optional[str] = None + + def __init__( + self, + *, + created_timestamp: "datetime | Unset_Type" = Unset, + created_user_or_group: "GsaUserOrGroup | Unset_Type" = Unset, + criteria: "str | None | Unset_Type" = Unset, + current_user_access_info: "dict[str, dict[str, bool]] | None | Unset_Type" = Unset, + description: "str | None | Unset_Type" = Unset, + explore_config: "str | None | Unset_Type" = Unset, + last_modified_timestamp: "datetime | Unset_Type" = Unset, + last_modified_user_or_group: "GsaUserOrGroup | Unset_Type" = Unset, + name: "str | None | Unset_Type" = Unset, + notes: "str | None | Unset_Type" = Unset, + search_identifier: "str | Unset_Type" = Unset, + ) -> None: + """GsaSelectionSearch - a model defined in Swagger + + Parameters + ---------- + created_timestamp: datetime, optional + created_user_or_group: GsaUserOrGroup, optional + criteria: str | None, optional + current_user_access_info: dict[str, dict[str, bool]] | None, optional + description: str | None, optional + explore_config: str | None, optional + last_modified_timestamp: datetime, optional + last_modified_user_or_group: GsaUserOrGroup, optional + name: str | None, optional + notes: str | None, optional + search_identifier: str, optional + """ + self._search_identifier: str | Unset_Type = Unset + self._name: str | None | Unset_Type = Unset + self._description: str | None | Unset_Type = Unset + self._notes: str | None | Unset_Type = Unset + self._current_user_access_info: dict[str, dict[str, bool]] | None | Unset_Type = Unset + self._criteria: str | None | Unset_Type = Unset + self._explore_config: str | None | Unset_Type = Unset + self._created_timestamp: datetime | Unset_Type = Unset + self._created_user_or_group: GsaUserOrGroup | Unset_Type = Unset + self._last_modified_timestamp: datetime | Unset_Type = Unset + self._last_modified_user_or_group: GsaUserOrGroup | Unset_Type = Unset + + if search_identifier is not Unset: + self.search_identifier = search_identifier + if name is not Unset: + self.name = name + if description is not Unset: + self.description = description + if notes is not Unset: + self.notes = notes + if current_user_access_info is not Unset: + self.current_user_access_info = current_user_access_info + if criteria is not Unset: + self.criteria = criteria + if explore_config is not Unset: + self.explore_config = explore_config + if created_timestamp is not Unset: + self.created_timestamp = created_timestamp + if created_user_or_group is not Unset: + self.created_user_or_group = created_user_or_group + if last_modified_timestamp is not Unset: + self.last_modified_timestamp = last_modified_timestamp + if last_modified_user_or_group is not Unset: + self.last_modified_user_or_group = last_modified_user_or_group + + @property + def search_identifier(self) -> "str | Unset_Type": + """Gets the search_identifier of this GsaSelectionSearch. + + Returns + ------- + str | Unset_Type + The search_identifier of this GsaSelectionSearch. + """ + return self._search_identifier + + @search_identifier.setter + def search_identifier(self, search_identifier: "str | Unset_Type") -> None: + """Sets the search_identifier of this GsaSelectionSearch. + + Parameters + ---------- + search_identifier: str | Unset_Type + The search_identifier of this GsaSelectionSearch. + """ + # Field is not nullable + if search_identifier is None: + raise ValueError("Invalid value for 'search_identifier', must not be 'None'") + self._search_identifier = search_identifier + + @property + def name(self) -> "str | None | Unset_Type": + """Gets the name of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The name of this GsaSelectionSearch. + """ + return self._name + + @name.setter + def name(self, name: "str | None | Unset_Type") -> None: + """Sets the name of this GsaSelectionSearch. + + Parameters + ---------- + name: str | None | Unset_Type + The name of this GsaSelectionSearch. + """ + self._name = name + + @property + def description(self) -> "str | None | Unset_Type": + """Gets the description of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The description of this GsaSelectionSearch. + """ + return self._description + + @description.setter + def description(self, description: "str | None | Unset_Type") -> None: + """Sets the description of this GsaSelectionSearch. + + Parameters + ---------- + description: str | None | Unset_Type + The description of this GsaSelectionSearch. + """ + self._description = description + + @property + def notes(self) -> "str | None | Unset_Type": + """Gets the notes of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The notes of this GsaSelectionSearch. + """ + return self._notes + + @notes.setter + def notes(self, notes: "str | None | Unset_Type") -> None: + """Sets the notes of this GsaSelectionSearch. + + Parameters + ---------- + notes: str | None | Unset_Type + The notes of this GsaSelectionSearch. + """ + self._notes = notes + + @property + def current_user_access_info(self) -> "dict[str, dict[str, bool]] | None | Unset_Type": + """Gets the current_user_access_info of this GsaSelectionSearch. + + Returns + ------- + dict[str, dict[str, bool]] | None | Unset_Type + The current_user_access_info of this GsaSelectionSearch. + """ + return self._current_user_access_info + + @current_user_access_info.setter + def current_user_access_info( + self, current_user_access_info: "dict[str, dict[str, bool]] | None | Unset_Type" + ) -> None: + """Sets the current_user_access_info of this GsaSelectionSearch. + + Parameters + ---------- + current_user_access_info: dict[str, dict[str, bool]] | None | Unset_Type + The current_user_access_info of this GsaSelectionSearch. + """ + self._current_user_access_info = current_user_access_info + + @property + def criteria(self) -> "str | None | Unset_Type": + """Gets the criteria of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The criteria of this GsaSelectionSearch. + """ + return self._criteria + + @criteria.setter + def criteria(self, criteria: "str | None | Unset_Type") -> None: + """Sets the criteria of this GsaSelectionSearch. + + Parameters + ---------- + criteria: str | None | Unset_Type + The criteria of this GsaSelectionSearch. + """ + self._criteria = criteria + + @property + def explore_config(self) -> "str | None | Unset_Type": + """Gets the explore_config of this GsaSelectionSearch. + + Returns + ------- + str | None | Unset_Type + The explore_config of this GsaSelectionSearch. + """ + return self._explore_config + + @explore_config.setter + def explore_config(self, explore_config: "str | None | Unset_Type") -> None: + """Sets the explore_config of this GsaSelectionSearch. + + Parameters + ---------- + explore_config: str | None | Unset_Type + The explore_config of this GsaSelectionSearch. + """ + self._explore_config = explore_config + + @property + def created_timestamp(self) -> "datetime | Unset_Type": + """Gets the created_timestamp of this GsaSelectionSearch. + + Returns + ------- + datetime | Unset_Type + The created_timestamp of this GsaSelectionSearch. + """ + return self._created_timestamp + + @created_timestamp.setter + def created_timestamp(self, created_timestamp: "datetime | Unset_Type") -> None: + """Sets the created_timestamp of this GsaSelectionSearch. + + Parameters + ---------- + created_timestamp: datetime | Unset_Type + The created_timestamp of this GsaSelectionSearch. + """ + # Field is not nullable + if created_timestamp is None: + raise ValueError("Invalid value for 'created_timestamp', must not be 'None'") + self._created_timestamp = created_timestamp + + @property + def created_user_or_group(self) -> "GsaUserOrGroup | Unset_Type": + """Gets the created_user_or_group of this GsaSelectionSearch. + + Returns + ------- + GsaUserOrGroup | Unset_Type + The created_user_or_group of this GsaSelectionSearch. + """ + return self._created_user_or_group + + @created_user_or_group.setter + def created_user_or_group(self, created_user_or_group: "GsaUserOrGroup | Unset_Type") -> None: + """Sets the created_user_or_group of this GsaSelectionSearch. + + Parameters + ---------- + created_user_or_group: GsaUserOrGroup | Unset_Type + The created_user_or_group of this GsaSelectionSearch. + """ + # Field is not nullable + if created_user_or_group is None: + raise ValueError("Invalid value for 'created_user_or_group', must not be 'None'") + self._created_user_or_group = created_user_or_group + + @property + def last_modified_timestamp(self) -> "datetime | Unset_Type": + """Gets the last_modified_timestamp of this GsaSelectionSearch. + + Returns + ------- + datetime | Unset_Type + The last_modified_timestamp of this GsaSelectionSearch. + """ + return self._last_modified_timestamp + + @last_modified_timestamp.setter + def last_modified_timestamp(self, last_modified_timestamp: "datetime | Unset_Type") -> None: + """Sets the last_modified_timestamp of this GsaSelectionSearch. + + Parameters + ---------- + last_modified_timestamp: datetime | Unset_Type + The last_modified_timestamp of this GsaSelectionSearch. + """ + # Field is not nullable + if last_modified_timestamp is None: + raise ValueError("Invalid value for 'last_modified_timestamp', must not be 'None'") + self._last_modified_timestamp = last_modified_timestamp + + @property + def last_modified_user_or_group(self) -> "GsaUserOrGroup | Unset_Type": + """Gets the last_modified_user_or_group of this GsaSelectionSearch. + + Returns + ------- + GsaUserOrGroup | Unset_Type + The last_modified_user_or_group of this GsaSelectionSearch. + """ + return self._last_modified_user_or_group + + @last_modified_user_or_group.setter + def last_modified_user_or_group( + self, last_modified_user_or_group: "GsaUserOrGroup | Unset_Type" + ) -> None: + """Sets the last_modified_user_or_group of this GsaSelectionSearch. + + Parameters + ---------- + last_modified_user_or_group: GsaUserOrGroup | Unset_Type + The last_modified_user_or_group of this GsaSelectionSearch. + """ + # Field is not nullable + if last_modified_user_or_group is None: + raise ValueError("Invalid value for 'last_modified_user_or_group', must not be 'None'") + self._last_modified_user_or_group = last_modified_user_or_group + + @classmethod + def get_real_child_model(cls, data: dict[str, str]) -> str: + """Raises a NotImplementedError for a type without a discriminator defined. + + Parameters + ---------- + data: ModelBase + Object representing a subclass of this class + + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() + + def __repr__(self) -> str: + """For 'print' and 'pprint'""" + return self.to_str() + + def __eq__(self, other: Any) -> bool: + """Returns true if both objects are equal""" + if not isinstance(other, GsaSelectionSearch): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other: Any) -> bool: + """Returns true if both objects are not equal""" + return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_range_datum.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_range_datum.py index 67d7c851a..fe3019364 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_range_datum.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_range_datum.py @@ -65,22 +65,23 @@ class GsaSetRangeDatum(GsaSetDatum): """ swagger_types: dict[str, str] = { "estimated": "bool", + "high_value": "float", + "high_value_is_inclusive": "bool", + "low_value": "float", + "low_value_is_inclusive": "bool", "set_datum_type": "GsaSetDatumType", - "high_endpoint": "GsaRangeEndpoint", - "low_endpoint": "GsaRangeEndpoint", } attribute_map: dict[str, str] = { "estimated": "estimated", + "high_value": "highValue", + "high_value_is_inclusive": "highValueIsInclusive", + "low_value": "lowValue", + "low_value_is_inclusive": "lowValueIsInclusive", "set_datum_type": "setDatumType", - "high_endpoint": "highEndpoint", - "low_endpoint": "lowEndpoint", } - subtype_mapping: dict[str, str] = { - "lowEndpoint": "GsaRangeEndpoint", - "highEndpoint": "GsaRangeEndpoint", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -88,79 +89,147 @@ def __init__( self, *, estimated: "bool", + high_value: "float", + high_value_is_inclusive: "bool", + low_value: "float", + low_value_is_inclusive: "bool", set_datum_type: "GsaSetDatumType" = GsaSetDatumType.RANGE, - high_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, - low_endpoint: "GsaRangeEndpoint | Unset_Type" = Unset, ) -> None: """GsaSetRangeDatum - a model defined in Swagger Parameters ---------- estimated: bool + high_value: float + high_value_is_inclusive: bool + low_value: float + low_value_is_inclusive: bool set_datum_type: GsaSetDatumType - high_endpoint: GsaRangeEndpoint, optional - low_endpoint: GsaRangeEndpoint, optional """ super().__init__(set_datum_type=set_datum_type) - self._low_endpoint: GsaRangeEndpoint | Unset_Type = Unset - self._high_endpoint: GsaRangeEndpoint | Unset_Type = Unset + self._low_value: float + self._high_value: float + self._low_value_is_inclusive: bool + self._high_value_is_inclusive: bool self._estimated: bool - if low_endpoint is not Unset: - self.low_endpoint = low_endpoint - if high_endpoint is not Unset: - self.high_endpoint = high_endpoint + self.low_value = low_value + self.high_value = high_value + self.low_value_is_inclusive = low_value_is_inclusive + self.high_value_is_inclusive = high_value_is_inclusive self.estimated = estimated @property - def low_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the low_endpoint of this GsaSetRangeDatum. + def low_value(self) -> "float": + """Gets the low_value of this GsaSetRangeDatum. + + Returns + ------- + float + The low_value of this GsaSetRangeDatum. + """ + return self._low_value + + @low_value.setter + def low_value(self, low_value: "float") -> None: + """Sets the low_value of this GsaSetRangeDatum. + + Parameters + ---------- + low_value: float + The low_value of this GsaSetRangeDatum. + """ + # Field is not nullable + if low_value is None: + raise ValueError("Invalid value for 'low_value', must not be 'None'") + # Field is required + if low_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value', must not be 'Unset'") + self._low_value = low_value + + @property + def high_value(self) -> "float": + """Gets the high_value of this GsaSetRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaSetRangeDatum. + float + The high_value of this GsaSetRangeDatum. """ - return self._low_endpoint + return self._high_value - @low_endpoint.setter - def low_endpoint(self, low_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the low_endpoint of this GsaSetRangeDatum. + @high_value.setter + def high_value(self, high_value: "float") -> None: + """Sets the high_value of this GsaSetRangeDatum. Parameters ---------- - low_endpoint: GsaRangeEndpoint | Unset_Type - The low_endpoint of this GsaSetRangeDatum. + high_value: float + The high_value of this GsaSetRangeDatum. """ # Field is not nullable - if low_endpoint is None: - raise ValueError("Invalid value for 'low_endpoint', must not be 'None'") - self._low_endpoint = low_endpoint + if high_value is None: + raise ValueError("Invalid value for 'high_value', must not be 'None'") + # Field is required + if high_value is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value', must not be 'Unset'") + self._high_value = high_value @property - def high_endpoint(self) -> "GsaRangeEndpoint | Unset_Type": - """Gets the high_endpoint of this GsaSetRangeDatum. + def low_value_is_inclusive(self) -> "bool": + """Gets the low_value_is_inclusive of this GsaSetRangeDatum. Returns ------- - GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaSetRangeDatum. + bool + The low_value_is_inclusive of this GsaSetRangeDatum. """ - return self._high_endpoint + return self._low_value_is_inclusive - @high_endpoint.setter - def high_endpoint(self, high_endpoint: "GsaRangeEndpoint | Unset_Type") -> None: - """Sets the high_endpoint of this GsaSetRangeDatum. + @low_value_is_inclusive.setter + def low_value_is_inclusive(self, low_value_is_inclusive: "bool") -> None: + """Sets the low_value_is_inclusive of this GsaSetRangeDatum. Parameters ---------- - high_endpoint: GsaRangeEndpoint | Unset_Type - The high_endpoint of this GsaSetRangeDatum. + low_value_is_inclusive: bool + The low_value_is_inclusive of this GsaSetRangeDatum. """ # Field is not nullable - if high_endpoint is None: - raise ValueError("Invalid value for 'high_endpoint', must not be 'None'") - self._high_endpoint = high_endpoint + if low_value_is_inclusive is None: + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'None'") + # Field is required + if low_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'low_value_is_inclusive', must not be 'Unset'") + self._low_value_is_inclusive = low_value_is_inclusive + + @property + def high_value_is_inclusive(self) -> "bool": + """Gets the high_value_is_inclusive of this GsaSetRangeDatum. + + Returns + ------- + bool + The high_value_is_inclusive of this GsaSetRangeDatum. + """ + return self._high_value_is_inclusive + + @high_value_is_inclusive.setter + def high_value_is_inclusive(self, high_value_is_inclusive: "bool") -> None: + """Sets the high_value_is_inclusive of this GsaSetRangeDatum. + + Parameters + ---------- + high_value_is_inclusive: bool + The high_value_is_inclusive of this GsaSetRangeDatum. + """ + # Field is not nullable + if high_value_is_inclusive is None: + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'None'") + # Field is required + if high_value_is_inclusive is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'high_value_is_inclusive', must not be 'Unset'") + self._high_value_is_inclusive = high_value_is_inclusive @property def estimated(self) -> "bool": diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalent.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalent.py deleted file mode 100644 index 46bb7ffe2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalent.py +++ /dev/null @@ -1,215 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalent(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "equivalent_unit_guid": "str", - "unit_guid": "str", - "unit_system_guid": "str", - } - - attribute_map: dict[str, str] = { - "equivalent_unit_guid": "equivalentUnitGuid", - "unit_guid": "unitGuid", - "unit_system_guid": "unitSystemGuid", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - equivalent_unit_guid: "str", - unit_guid: "str", - unit_system_guid: "str", - ) -> None: - """GsaSetUnitEquivalent - a model defined in Swagger - - Parameters - ---------- - equivalent_unit_guid: str - unit_guid: str - unit_system_guid: str - """ - self._unit_guid: str - self._unit_system_guid: str - self._equivalent_unit_guid: str - - self.unit_guid = unit_guid - self.unit_system_guid = unit_system_guid - self.equivalent_unit_guid = equivalent_unit_guid - - @property - def unit_guid(self) -> "str": - """Gets the unit_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The unit_guid of this GsaSetUnitEquivalent. - """ - return self._unit_guid - - @unit_guid.setter - def unit_guid(self, unit_guid: "str") -> None: - """Sets the unit_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - unit_guid: str - The unit_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if unit_guid is None: - raise ValueError("Invalid value for 'unit_guid', must not be 'None'") - # Field is required - if unit_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit_guid', must not be 'Unset'") - self._unit_guid = unit_guid - - @property - def unit_system_guid(self) -> "str": - """Gets the unit_system_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The unit_system_guid of this GsaSetUnitEquivalent. - """ - return self._unit_system_guid - - @unit_system_guid.setter - def unit_system_guid(self, unit_system_guid: "str") -> None: - """Sets the unit_system_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - unit_system_guid: str - The unit_system_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if unit_system_guid is None: - raise ValueError("Invalid value for 'unit_system_guid', must not be 'None'") - # Field is required - if unit_system_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unit_system_guid', must not be 'Unset'") - self._unit_system_guid = unit_system_guid - - @property - def equivalent_unit_guid(self) -> "str": - """Gets the equivalent_unit_guid of this GsaSetUnitEquivalent. - - Returns - ------- - str - The equivalent_unit_guid of this GsaSetUnitEquivalent. - """ - return self._equivalent_unit_guid - - @equivalent_unit_guid.setter - def equivalent_unit_guid(self, equivalent_unit_guid: "str") -> None: - """Sets the equivalent_unit_guid of this GsaSetUnitEquivalent. - - Parameters - ---------- - equivalent_unit_guid: str - The equivalent_unit_guid of this GsaSetUnitEquivalent. - """ - # Field is not nullable - if equivalent_unit_guid is None: - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'None'") - # Field is required - if equivalent_unit_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equivalent_unit_guid', must not be 'Unset'") - self._equivalent_unit_guid = equivalent_unit_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalent): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_exception.py deleted file mode 100644 index 16c7e1d1d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalentsException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaUnitEquivalentErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitEquivalentErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSetUnitEquivalentsException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaUnitEquivalentErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaSetUnitEquivalentsException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaSetUnitEquivalentsException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaSetUnitEquivalentsException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaSetUnitEquivalentsException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaSetUnitEquivalentsException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaSetUnitEquivalentsException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaSetUnitEquivalentsException. - - Returns - ------- - list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaSetUnitEquivalentsException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquivalentErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaSetUnitEquivalentsException. - - Parameters - ---------- - errors: list[GsaUnitEquivalentErrorDetail] | None | Unset_Type - The errors of this GsaSetUnitEquivalentsException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalentsException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_info.py deleted file mode 100644 index b0562410b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_set_unit_equivalents_info.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSetUnitEquivalentsInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "set_unit_equivalents": "list[GsaSetUnitEquivalent]", - } - - attribute_map: dict[str, str] = { - "set_unit_equivalents": "setUnitEquivalents", - } - - subtype_mapping: dict[str, str] = { - "setUnitEquivalents": "GsaSetUnitEquivalent", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - set_unit_equivalents: "list[GsaSetUnitEquivalent] | None | Unset_Type" = Unset, - ) -> None: - """GsaSetUnitEquivalentsInfo - a model defined in Swagger - - Parameters - ---------- - set_unit_equivalents: list[GsaSetUnitEquivalent] | None, optional - """ - self._set_unit_equivalents: list[GsaSetUnitEquivalent] | None | Unset_Type = Unset - - if set_unit_equivalents is not Unset: - self.set_unit_equivalents = set_unit_equivalents - - @property - def set_unit_equivalents(self) -> "list[GsaSetUnitEquivalent] | None | Unset_Type": - """Gets the set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - - Returns - ------- - list[GsaSetUnitEquivalent] | None | Unset_Type - The set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - """ - return self._set_unit_equivalents - - @set_unit_equivalents.setter - def set_unit_equivalents( - self, set_unit_equivalents: "list[GsaSetUnitEquivalent] | None | Unset_Type" - ) -> None: - """Sets the set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - - Parameters - ---------- - set_unit_equivalents: list[GsaSetUnitEquivalent] | None | Unset_Type - The set_unit_equivalents of this GsaSetUnitEquivalentsInfo. - """ - self._set_unit_equivalents = set_unit_equivalents - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSetUnitEquivalentsInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_short_text_attribute.py index 5c4e1708a..5b615b90b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_short_text_attribute.py @@ -69,7 +69,6 @@ class GsaShortTextAttribute(GsaAttribute): "guid": "str", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "is_unique": "bool", "name": "str", "table": "GsaSlimEntity", @@ -86,7 +85,6 @@ class GsaShortTextAttribute(GsaAttribute): "guid": "guid", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "is_unique": "isUnique", "name": "name", "table": "table", @@ -111,7 +109,6 @@ def __init__( guid: "str", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", is_unique: "bool", name: "str", table: "GsaSlimEntity", @@ -130,7 +127,6 @@ def __init__( guid: str info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool is_unique: bool name: str table: GsaSlimEntity @@ -146,7 +142,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_setting.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_setting.py deleted file mode 100644 index ded3d08ac..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_setting.py +++ /dev/null @@ -1,218 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSimilaritySetting(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute": "GsaSlimEntity", - "weight": "float", - "weighting_type": "GsaWeightingType", - } - - attribute_map: dict[str, str] = { - "attribute": "attribute", - "weight": "weight", - "weighting_type": "weightingType", - } - - subtype_mapping: dict[str, str] = { - "attribute": "GsaSlimEntity", - "weightingType": "GsaWeightingType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute: "GsaSlimEntity", - weight: "float", - weighting_type: "GsaWeightingType", - ) -> None: - """GsaSimilaritySetting - a model defined in Swagger - - Parameters - ---------- - attribute: GsaSlimEntity - weight: float - weighting_type: GsaWeightingType - """ - self._attribute: GsaSlimEntity - self._weight: float - self._weighting_type: GsaWeightingType - - self.attribute = attribute - self.weight = weight - self.weighting_type = weighting_type - - @property - def attribute(self) -> "GsaSlimEntity": - """Gets the attribute of this GsaSimilaritySetting. - - Returns - ------- - GsaSlimEntity - The attribute of this GsaSimilaritySetting. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity") -> None: - """Sets the attribute of this GsaSimilaritySetting. - - Parameters - ---------- - attribute: GsaSlimEntity - The attribute of this GsaSimilaritySetting. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - # Field is required - if attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute', must not be 'Unset'") - self._attribute = attribute - - @property - def weight(self) -> "float": - """Gets the weight of this GsaSimilaritySetting. - - Returns - ------- - float - The weight of this GsaSimilaritySetting. - """ - return self._weight - - @weight.setter - def weight(self, weight: "float") -> None: - """Sets the weight of this GsaSimilaritySetting. - - Parameters - ---------- - weight: float - The weight of this GsaSimilaritySetting. - """ - # Field is not nullable - if weight is None: - raise ValueError("Invalid value for 'weight', must not be 'None'") - # Field is required - if weight is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'weight', must not be 'Unset'") - self._weight = weight - - @property - def weighting_type(self) -> "GsaWeightingType": - """Gets the weighting_type of this GsaSimilaritySetting. - - Returns - ------- - GsaWeightingType - The weighting_type of this GsaSimilaritySetting. - """ - return self._weighting_type - - @weighting_type.setter - def weighting_type(self, weighting_type: "GsaWeightingType") -> None: - """Sets the weighting_type of this GsaSimilaritySetting. - - Parameters - ---------- - weighting_type: GsaWeightingType - The weighting_type of this GsaSimilaritySetting. - """ - # Field is not nullable - if weighting_type is None: - raise ValueError("Invalid value for 'weighting_type', must not be 'None'") - # Field is required - if weighting_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'weighting_type', must not be 'Unset'") - self._weighting_type = weighting_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSimilaritySetting): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_settings.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_settings.py deleted file mode 100644 index ba39d2e9d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_similarity_settings.py +++ /dev/null @@ -1,242 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSimilaritySettings(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "settings": "list[GsaSimilaritySetting]", - "is_default": "bool", - "table_guid": "str", - "use_knockdown": "bool", - } - - attribute_map: dict[str, str] = { - "settings": "settings", - "is_default": "isDefault", - "table_guid": "tableGuid", - "use_knockdown": "useKnockdown", - } - - subtype_mapping: dict[str, str] = { - "settings": "GsaSimilaritySetting", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - settings: "list[GsaSimilaritySetting]", - is_default: "bool | Unset_Type" = Unset, - table_guid: "str | None | Unset_Type" = Unset, - use_knockdown: "bool | Unset_Type" = Unset, - ) -> None: - """GsaSimilaritySettings - a model defined in Swagger - - Parameters - ---------- - settings: list[GsaSimilaritySetting] - is_default: bool, optional - table_guid: str | None, optional - use_knockdown: bool, optional - """ - self._table_guid: str | None | Unset_Type = Unset - self._use_knockdown: bool | Unset_Type = Unset - self._is_default: bool | Unset_Type = Unset - self._settings: list[GsaSimilaritySetting] - - if table_guid is not Unset: - self.table_guid = table_guid - if use_knockdown is not Unset: - self.use_knockdown = use_knockdown - if is_default is not Unset: - self.is_default = is_default - self.settings = settings - - @property - def table_guid(self) -> "str | None | Unset_Type": - """Gets the table_guid of this GsaSimilaritySettings. - - Returns - ------- - str | None | Unset_Type - The table_guid of this GsaSimilaritySettings. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | None | Unset_Type") -> None: - """Sets the table_guid of this GsaSimilaritySettings. - - Parameters - ---------- - table_guid: str | None | Unset_Type - The table_guid of this GsaSimilaritySettings. - """ - self._table_guid = table_guid - - @property - def use_knockdown(self) -> "bool | Unset_Type": - """Gets the use_knockdown of this GsaSimilaritySettings. - - Returns - ------- - bool | Unset_Type - The use_knockdown of this GsaSimilaritySettings. - """ - return self._use_knockdown - - @use_knockdown.setter - def use_knockdown(self, use_knockdown: "bool | Unset_Type") -> None: - """Sets the use_knockdown of this GsaSimilaritySettings. - - Parameters - ---------- - use_knockdown: bool | Unset_Type - The use_knockdown of this GsaSimilaritySettings. - """ - # Field is not nullable - if use_knockdown is None: - raise ValueError("Invalid value for 'use_knockdown', must not be 'None'") - self._use_knockdown = use_knockdown - - @property - def is_default(self) -> "bool | Unset_Type": - """Gets the is_default of this GsaSimilaritySettings. - - Returns - ------- - bool | Unset_Type - The is_default of this GsaSimilaritySettings. - """ - return self._is_default - - @is_default.setter - def is_default(self, is_default: "bool | Unset_Type") -> None: - """Sets the is_default of this GsaSimilaritySettings. - - Parameters - ---------- - is_default: bool | Unset_Type - The is_default of this GsaSimilaritySettings. - """ - # Field is not nullable - if is_default is None: - raise ValueError("Invalid value for 'is_default', must not be 'None'") - self._is_default = is_default - - @property - def settings(self) -> "list[GsaSimilaritySetting]": - """Gets the settings of this GsaSimilaritySettings. - - Returns - ------- - list[GsaSimilaritySetting] - The settings of this GsaSimilaritySettings. - """ - return self._settings - - @settings.setter - def settings(self, settings: "list[GsaSimilaritySetting]") -> None: - """Sets the settings of this GsaSimilaritySettings. - - Parameters - ---------- - settings: list[GsaSimilaritySetting] - The settings of this GsaSimilaritySettings. - """ - # Field is not nullable - if settings is None: - raise ValueError("Invalid value for 'settings', must not be 'None'") - # Field is required - if settings is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'settings', must not be 'Unset'") - self._settings = settings - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSimilaritySettings): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute.py index 713fb8643..3c389fc5c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute.py @@ -64,7 +64,6 @@ class GsaSlimAttribute(ModelBase): "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "type": "GsaAttributeType", @@ -75,7 +74,6 @@ class GsaSlimAttribute(ModelBase): "display_names": "displayNames", "guid": "guid", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "type": "type", @@ -96,7 +94,6 @@ def __init__( display_names: "dict[str, str]", guid: "str", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", type: "GsaAttributeType", @@ -109,7 +106,6 @@ def __init__( display_names: dict[str, str] guid: str is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity type: GsaAttributeType @@ -118,7 +114,6 @@ def __init__( self._type: GsaAttributeType self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset self._is_hidden_from_search_criteria: bool - self._is_protected: bool self._table: GsaSlimEntity self._display_names: dict[str, str] self._name: str @@ -128,7 +123,6 @@ def __init__( if about_attribute is not Unset: self.about_attribute = about_attribute self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected self.table = table self.display_names = display_names self.name = name @@ -221,36 +215,6 @@ def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") ) self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimAttribute. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimAttribute. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimAttribute. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimAttribute. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def table(self) -> "GsaSlimEntity": """Gets the table of this GsaSlimAttribute. @@ -282,7 +246,6 @@ def table(self, table: "GsaSlimEntity") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -294,7 +257,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute_with_help_path.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute_with_help_path.py deleted file mode 100644 index a63287100..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_attribute_with_help_path.py +++ /dev/null @@ -1,426 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimAttributeWithHelpPath(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", - "name": "str", - "table": "GsaSlimEntity", - "type": "GsaAttributeType", - "about_attribute": "GsaSlimTypedAttribute", - "help_path": "str", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", - "name": "name", - "table": "table", - "type": "type", - "about_attribute": "aboutAttribute", - "help_path": "helpPath", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaAttributeType", - "aboutAttribute": "GsaSlimTypedAttribute", - "table": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - is_hidden_from_search_criteria: "bool", - is_protected: "bool", - name: "str", - table: "GsaSlimEntity", - type: "GsaAttributeType", - about_attribute: "GsaSlimTypedAttribute | Unset_Type" = Unset, - help_path: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSlimAttributeWithHelpPath - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - is_hidden_from_search_criteria: bool - is_protected: bool - name: str - table: GsaSlimEntity - type: GsaAttributeType - about_attribute: GsaSlimTypedAttribute, optional - help_path: str | None, optional - """ - self._help_path: str | None | Unset_Type = Unset - self._type: GsaAttributeType - self._about_attribute: GsaSlimTypedAttribute | Unset_Type = Unset - self._is_hidden_from_search_criteria: bool - self._is_protected: bool - self._table: GsaSlimEntity - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if help_path is not Unset: - self.help_path = help_path - self.type = type - if about_attribute is not Unset: - self.about_attribute = about_attribute - self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - self.is_protected = is_protected - self.table = table - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaSlimAttributeWithHelpPath. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaSlimAttributeWithHelpPath. - """ - self._help_path = help_path - - @property - def type(self) -> "GsaAttributeType": - """Gets the type of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaAttributeType - The type of this GsaSlimAttributeWithHelpPath. - """ - return self._type - - @type.setter - def type(self, type: "GsaAttributeType") -> None: - """Sets the type of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - type: GsaAttributeType - The type of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def about_attribute(self) -> "GsaSlimTypedAttribute | Unset_Type": - """Gets the about_attribute of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaSlimAttributeWithHelpPath. - """ - return self._about_attribute - - @about_attribute.setter - def about_attribute(self, about_attribute: "GsaSlimTypedAttribute | Unset_Type") -> None: - """Sets the about_attribute of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - about_attribute: GsaSlimTypedAttribute | Unset_Type - The about_attribute of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if about_attribute is None: - raise ValueError("Invalid value for 'about_attribute', must not be 'None'") - self._about_attribute = about_attribute - - @property - def is_hidden_from_search_criteria(self) -> "bool": - """Gets the is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - If true, the attribute should not be shown in search UIs. It will still be included in text searches. - - Returns - ------- - bool - The is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - """ - return self._is_hidden_from_search_criteria - - @is_hidden_from_search_criteria.setter - def is_hidden_from_search_criteria(self, is_hidden_from_search_criteria: "bool") -> None: - """Sets the is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - If true, the attribute should not be shown in search UIs. It will still be included in text searches. - - Parameters - ---------- - is_hidden_from_search_criteria: bool - The is_hidden_from_search_criteria of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if is_hidden_from_search_criteria is None: - raise ValueError( - "Invalid value for 'is_hidden_from_search_criteria', must not be 'None'" - ) - # Field is required - if is_hidden_from_search_criteria is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'is_hidden_from_search_criteria', must not be 'Unset'" - ) - self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimAttributeWithHelpPath. - If true, the attribute is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimAttributeWithHelpPath. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimAttributeWithHelpPath. - If true, the attribute is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - GsaSlimEntity - The table of this GsaSlimAttributeWithHelpPath. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimAttributeWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimAttributeWithHelpPath. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimAttributeWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str - The name of this GsaSlimAttributeWithHelpPath. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - name: str - The name of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSlimAttributeWithHelpPath. - - Returns - ------- - str - The guid of this GsaSlimAttributeWithHelpPath. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimAttributeWithHelpPath. - - Parameters - ---------- - guid: str - The guid of this GsaSlimAttributeWithHelpPath. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimAttributeWithHelpPath): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_token.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_constant.py similarity index 76% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_token.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_constant.py index d0e68dbbe..22bf43bab 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_data_update_token.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_constant.py @@ -42,7 +42,7 @@ from . import * -class GsaDataUpdateToken(ModelBase): +class GsaSlimConstant(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -61,13 +61,13 @@ class GsaDataUpdateToken(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "database_key": "str", "guid": "str", + "name": "str", } attribute_map: dict[str, str] = { - "database_key": "databaseKey", "guid": "guid", + "name": "name", } subtype_mapping: dict[str, str] = {} @@ -77,77 +77,77 @@ class GsaDataUpdateToken(ModelBase): def __init__( self, *, - database_key: "str", guid: "str", + name: "str", ) -> None: - """GsaDataUpdateToken - a model defined in Swagger + """GsaSlimConstant - a model defined in Swagger Parameters ---------- - database_key: str guid: str + name: str """ + self._name: str self._guid: str - self._database_key: str + self.name = name self.guid = guid - self.database_key = database_key @property - def guid(self) -> "str": - """Gets the guid of this GsaDataUpdateToken. + def name(self) -> "str": + """Gets the name of this GsaSlimConstant. Returns ------- str - The guid of this GsaDataUpdateToken. + The name of this GsaSlimConstant. """ - return self._guid + return self._name - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaDataUpdateToken. + @name.setter + def name(self, name: "str") -> None: + """Sets the name of this GsaSlimConstant. Parameters ---------- - guid: str - The guid of this GsaDataUpdateToken. + name: str + The name of this GsaSlimConstant. """ # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") + if name is None: + raise ValueError("Invalid value for 'name', must not be 'None'") # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid + if name is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'name', must not be 'Unset'") + self._name = name @property - def database_key(self) -> "str": - """Gets the database_key of this GsaDataUpdateToken. + def guid(self) -> "str": + """Gets the guid of this GsaSlimConstant. Returns ------- str - The database_key of this GsaDataUpdateToken. + The guid of this GsaSlimConstant. """ - return self._database_key + return self._guid - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaDataUpdateToken. + @guid.setter + def guid(self, guid: "str") -> None: + """Sets the guid of this GsaSlimConstant. Parameters ---------- - database_key: str - The database_key of this GsaDataUpdateToken. + guid: str + The guid of this GsaSlimConstant. """ # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") + if guid is None: + raise ValueError("Invalid value for 'guid', must not be 'None'") # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key + if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'guid', must not be 'Unset'") + self._guid = guid @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: @@ -171,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaDataUpdateToken): + if not isinstance(other, GsaSlimConstant): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_database.py index b88d5249a..75e54985e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_database.py @@ -65,13 +65,10 @@ class GsaSlimDatabase(ModelBase): "is_read_only": "bool", "key": "str", "status": "GsaDatabaseStatus", - "user_capabilities": "GsaDatabaseUserCapabilities", - "configuration_details": "GsaConfigurationDetails", "guid": "str", "index_in_sync": "bool", "index_out_of_date_duration": "str", "index_up_to_date": "bool", - "issues": "GsaDatabaseIssues", "name": "str", "schema_version": "str", "version_guid": "str", @@ -82,13 +79,10 @@ class GsaSlimDatabase(ModelBase): "is_read_only": "isReadOnly", "key": "key", "status": "status", - "user_capabilities": "userCapabilities", - "configuration_details": "configurationDetails", "guid": "guid", "index_in_sync": "indexInSync", "index_out_of_date_duration": "indexOutOfDateDuration", "index_up_to_date": "indexUpToDate", - "issues": "issues", "name": "name", "schema_version": "schemaVersion", "version_guid": "versionGuid", @@ -96,9 +90,6 @@ class GsaSlimDatabase(ModelBase): subtype_mapping: dict[str, str] = { "status": "GsaDatabaseStatus", - "userCapabilities": "GsaDatabaseUserCapabilities", - "configurationDetails": "GsaConfigurationDetails", - "issues": "GsaDatabaseIssues", } discriminator: Optional[str] = None @@ -110,13 +101,10 @@ def __init__( is_read_only: "bool", key: "str", status: "GsaDatabaseStatus", - user_capabilities: "GsaDatabaseUserCapabilities", - configuration_details: "GsaConfigurationDetails | Unset_Type" = Unset, guid: "str | None | Unset_Type" = Unset, index_in_sync: "bool | None | Unset_Type" = Unset, index_out_of_date_duration: "str | None | Unset_Type" = Unset, index_up_to_date: "bool | None | Unset_Type" = Unset, - issues: "GsaDatabaseIssues | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, schema_version: "str | None | Unset_Type" = Unset, version_guid: "str | None | Unset_Type" = Unset, @@ -129,13 +117,10 @@ def __init__( is_read_only: bool key: str status: GsaDatabaseStatus - user_capabilities: GsaDatabaseUserCapabilities - configuration_details: GsaConfigurationDetails, optional guid: str | None, optional index_in_sync: bool | None, optional index_out_of_date_duration: str | None, optional index_up_to_date: bool | None, optional - issues: GsaDatabaseIssues, optional name: str | None, optional schema_version: str | None, optional version_guid: str | None, optional @@ -151,9 +136,6 @@ def __init__( self._index_up_to_date: bool | None | Unset_Type = Unset self._index_out_of_date_duration: str | None | Unset_Type = Unset self._schema_version: str | None | Unset_Type = Unset - self._user_capabilities: GsaDatabaseUserCapabilities - self._configuration_details: GsaConfigurationDetails | Unset_Type = Unset - self._issues: GsaDatabaseIssues | Unset_Type = Unset self.key = key self.status = status @@ -173,11 +155,6 @@ def __init__( self.index_out_of_date_duration = index_out_of_date_duration if schema_version is not Unset: self.schema_version = schema_version - self.user_capabilities = user_capabilities - if configuration_details is not Unset: - self.configuration_details = configuration_details - if issues is not Unset: - self.issues = issues @property def key(self) -> "str": @@ -447,86 +424,6 @@ def schema_version(self, schema_version: "str | None | Unset_Type") -> None: """ self._schema_version = schema_version - @property - def user_capabilities(self) -> "GsaDatabaseUserCapabilities": - """Gets the user_capabilities of this GsaSlimDatabase. - - Returns - ------- - GsaDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabase. - """ - return self._user_capabilities - - @user_capabilities.setter - def user_capabilities(self, user_capabilities: "GsaDatabaseUserCapabilities") -> None: - """Sets the user_capabilities of this GsaSlimDatabase. - - Parameters - ---------- - user_capabilities: GsaDatabaseUserCapabilities - The user_capabilities of this GsaSlimDatabase. - """ - # Field is not nullable - if user_capabilities is None: - raise ValueError("Invalid value for 'user_capabilities', must not be 'None'") - # Field is required - if user_capabilities is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'user_capabilities', must not be 'Unset'") - self._user_capabilities = user_capabilities - - @property - def configuration_details(self) -> "GsaConfigurationDetails | Unset_Type": - """Gets the configuration_details of this GsaSlimDatabase. - - Returns - ------- - GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaSlimDatabase. - """ - return self._configuration_details - - @configuration_details.setter - def configuration_details( - self, configuration_details: "GsaConfigurationDetails | Unset_Type" - ) -> None: - """Sets the configuration_details of this GsaSlimDatabase. - - Parameters - ---------- - configuration_details: GsaConfigurationDetails | Unset_Type - The configuration_details of this GsaSlimDatabase. - """ - # Field is not nullable - if configuration_details is None: - raise ValueError("Invalid value for 'configuration_details', must not be 'None'") - self._configuration_details = configuration_details - - @property - def issues(self) -> "GsaDatabaseIssues | Unset_Type": - """Gets the issues of this GsaSlimDatabase. - - Returns - ------- - GsaDatabaseIssues | Unset_Type - The issues of this GsaSlimDatabase. - """ - return self._issues - - @issues.setter - def issues(self, issues: "GsaDatabaseIssues | Unset_Type") -> None: - """Sets the issues of this GsaSlimDatabase. - - Parameters - ---------- - issues: GsaDatabaseIssues | Unset_Type - The issues of this GsaSlimDatabase. - """ - # Field is not nullable - if issues is None: - raise ValueError("Invalid value for 'issues', must not be 'None'") - self._issues = issues - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_discrete_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_discrete_type.py index b60931f2e..08ef248c5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_discrete_type.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_discrete_type.py @@ -63,14 +63,12 @@ class GsaSlimDiscreteType(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "is_ordered": "bool", - "is_protected": "bool", "name": "str", } attribute_map: dict[str, str] = { "guid": "guid", "is_ordered": "isOrdered", - "is_protected": "isProtected", "name": "name", } @@ -83,7 +81,6 @@ def __init__( *, guid: "str", is_ordered: "bool", - is_protected: "bool", name: "str", ) -> None: """GsaSlimDiscreteType - a model defined in Swagger @@ -92,16 +89,13 @@ def __init__( ---------- guid: str is_ordered: bool - is_protected: bool name: str """ self._is_ordered: bool - self._is_protected: bool self._name: str self._guid: str self.is_ordered = is_ordered - self.is_protected = is_protected self.name = name self.guid = guid @@ -133,36 +127,6 @@ def is_ordered(self, is_ordered: "bool") -> None: raise ValueError("Invalid value for 'is_ordered', must not be 'Unset'") self._is_ordered = is_ordered - @property - def is_protected(self) -> "bool": - """Gets the is_protected of this GsaSlimDiscreteType. - If true, the discrete type is protected from all changes. - - Returns - ------- - bool - The is_protected of this GsaSlimDiscreteType. - """ - return self._is_protected - - @is_protected.setter - def is_protected(self, is_protected: "bool") -> None: - """Sets the is_protected of this GsaSlimDiscreteType. - If true, the discrete type is protected from all changes. - - Parameters - ---------- - is_protected: bool - The is_protected of this GsaSlimDiscreteType. - """ - # Field is not nullable - if is_protected is None: - raise ValueError("Invalid value for 'is_protected', must not be 'None'") - # Field is required - if is_protected is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_protected', must not be 'Unset'") - self._is_protected = is_protected - @property def name(self) -> "str": """Gets the name of this GsaSlimDiscreteType. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_expression.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_expression.py index a5842cbab..81c8ef841 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_expression.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_expression.py @@ -63,18 +63,14 @@ class GsaSlimExpression(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "table": "GsaSlimEntity", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "table": "table", } - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -83,7 +79,6 @@ def __init__( *, guid: "str", name: "str", - table: "GsaSlimEntity", ) -> None: """GsaSlimExpression - a model defined in Swagger @@ -91,44 +86,13 @@ def __init__( ---------- guid: str name: str - table: GsaSlimEntity """ - self._table: GsaSlimEntity self._name: str self._guid: str - self.table = table self.name = name self.guid = guid - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimExpression. - - Returns - ------- - GsaSlimEntity - The table of this GsaSlimExpression. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimExpression. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaSlimExpression. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - @property def name(self) -> "str": """Gets the name of this GsaSlimExpression. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_layout.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_layout.py index 1181f2521..995f3ffba 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_layout.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_layout.py @@ -102,7 +102,6 @@ def __init__( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -114,7 +113,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimLayout. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_named_unit.py similarity index 68% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_template.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_named_unit.py index 935d403c7..e7e0c2da7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_template.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_named_unit.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimSearchTemplate(ModelBase): +class GsaSlimNamedUnit(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -63,20 +63,18 @@ class GsaSlimSearchTemplate(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "table": "GsaSlimEntity", - "description": "str", + "symbol": "str", + "relative_symbol": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "table": "table", - "description": "description", + "symbol": "symbol", + "relative_symbol": "relativeSymbol", } - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -85,126 +83,126 @@ def __init__( *, guid: "str", name: "str", - table: "GsaSlimEntity", - description: "str | None | Unset_Type" = Unset, + symbol: "str", + relative_symbol: "str | None | Unset_Type" = Unset, ) -> None: - """GsaSlimSearchTemplate - a model defined in Swagger + """GsaSlimNamedUnit - a model defined in Swagger Parameters ---------- guid: str name: str - table: GsaSlimEntity - description: str | None, optional + symbol: str + relative_symbol: str | None, optional """ - self._description: str | None | Unset_Type = Unset - self._table: GsaSlimEntity self._name: str + self._symbol: str + self._relative_symbol: str | None | Unset_Type = Unset self._guid: str - if description is not Unset: - self.description = description - self.table = table self.name = name + self.symbol = symbol + if relative_symbol is not Unset: + self.relative_symbol = relative_symbol self.guid = guid @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSlimSearchTemplate. + def name(self) -> "str": + """Gets the name of this GsaSlimNamedUnit. Returns ------- - str | None | Unset_Type - The description of this GsaSlimSearchTemplate. + str + The name of this GsaSlimNamedUnit. """ - return self._description + return self._name - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSlimSearchTemplate. + @name.setter + def name(self, name: "str") -> None: + """Sets the name of this GsaSlimNamedUnit. Parameters ---------- - description: str | None | Unset_Type - The description of this GsaSlimSearchTemplate. + name: str + The name of this GsaSlimNamedUnit. """ - self._description = description + # Field is not nullable + if name is None: + raise ValueError("Invalid value for 'name', must not be 'None'") + # Field is required + if name is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'name', must not be 'Unset'") + self._name = name @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaSlimSearchTemplate. + def symbol(self) -> "str": + """Gets the symbol of this GsaSlimNamedUnit. Returns ------- - GsaSlimEntity - The table of this GsaSlimSearchTemplate. + str + The symbol of this GsaSlimNamedUnit. """ - return self._table + return self._symbol - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaSlimSearchTemplate. + @symbol.setter + def symbol(self, symbol: "str") -> None: + """Sets the symbol of this GsaSlimNamedUnit. Parameters ---------- - table: GsaSlimEntity - The table of this GsaSlimSearchTemplate. + symbol: str + The symbol of this GsaSlimNamedUnit. """ # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") + if symbol is None: + raise ValueError("Invalid value for 'symbol', must not be 'None'") # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table + if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'symbol', must not be 'Unset'") + self._symbol = symbol @property - def name(self) -> "str": - """Gets the name of this GsaSlimSearchTemplate. + def relative_symbol(self) -> "str | None | Unset_Type": + """Gets the relative_symbol of this GsaSlimNamedUnit. Returns ------- - str - The name of this GsaSlimSearchTemplate. + str | None | Unset_Type + The relative_symbol of this GsaSlimNamedUnit. """ - return self._name + return self._relative_symbol - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimSearchTemplate. + @relative_symbol.setter + def relative_symbol(self, relative_symbol: "str | None | Unset_Type") -> None: + """Sets the relative_symbol of this GsaSlimNamedUnit. Parameters ---------- - name: str - The name of this GsaSlimSearchTemplate. + relative_symbol: str | None | Unset_Type + The relative_symbol of this GsaSlimNamedUnit. """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name + self._relative_symbol = relative_symbol @property def guid(self) -> "str": - """Gets the guid of this GsaSlimSearchTemplate. + """Gets the guid of this GsaSlimNamedUnit. Returns ------- str - The guid of this GsaSlimSearchTemplate. + The guid of this GsaSlimNamedUnit. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimSearchTemplate. + """Sets the guid of this GsaSlimNamedUnit. Parameters ---------- guid: str - The guid of this GsaSlimSearchTemplate. + The guid of this GsaSlimNamedUnit. """ # Field is not nullable if guid is None: @@ -236,7 +234,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimSearchTemplate): + if not isinstance(other, GsaSlimNamedUnit): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter.py index 5d9985c3f..ad5bbdee1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter.py @@ -138,7 +138,6 @@ def type(self, type: "GsaParameterType") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -150,7 +149,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimParameter. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter_with_help_path.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter_with_help_path.py deleted file mode 100644 index 39b9086d9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_parameter_with_help_path.py +++ /dev/null @@ -1,282 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSlimParameterWithHelpPath(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "type": "GsaParameterType", - "help_path": "str", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "type": "type", - "help_path": "helpPath", - } - - subtype_mapping: dict[str, str] = { - "type": "GsaParameterType", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - name: "str", - type: "GsaParameterType", - help_path: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaSlimParameterWithHelpPath - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - name: str - type: GsaParameterType - help_path: str | None, optional - """ - self._help_path: str | None | Unset_Type = Unset - self._type: GsaParameterType - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if help_path is not Unset: - self.help_path = help_path - self.type = type - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def help_path(self) -> "str | None | Unset_Type": - """Gets the help_path of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str | None | Unset_Type - The help_path of this GsaSlimParameterWithHelpPath. - """ - return self._help_path - - @help_path.setter - def help_path(self, help_path: "str | None | Unset_Type") -> None: - """Sets the help_path of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - help_path: str | None | Unset_Type - The help_path of this GsaSlimParameterWithHelpPath. - """ - self._help_path = help_path - - @property - def type(self) -> "GsaParameterType": - """Gets the type of this GsaSlimParameterWithHelpPath. - - Returns - ------- - GsaParameterType - The type of this GsaSlimParameterWithHelpPath. - """ - return self._type - - @type.setter - def type(self, type: "GsaParameterType") -> None: - """Sets the type of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - type: GsaParameterType - The type of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if type is None: - raise ValueError("Invalid value for 'type', must not be 'None'") - # Field is required - if type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'type', must not be 'Unset'") - self._type = type - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimParameterWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimParameterWithHelpPath. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimParameterWithHelpPath. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str - The name of this GsaSlimParameterWithHelpPath. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - name: str - The name of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaSlimParameterWithHelpPath. - - Returns - ------- - str - The guid of this GsaSlimParameterWithHelpPath. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimParameterWithHelpPath. - - Parameters - ---------- - guid: str - The guid of this GsaSlimParameterWithHelpPath. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimParameterWithHelpPath): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_mask.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission.py similarity index 76% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_mask.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission.py index 337b53a33..39cd87eed 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_search_mask.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimSearchMask(ModelBase): +class GsaSlimPermission(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -63,13 +63,11 @@ class GsaSlimSearchMask(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "description": "str", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "description": "description", } subtype_mapping: dict[str, str] = {} @@ -81,66 +79,39 @@ def __init__( *, guid: "str", name: "str", - description: "str | None | Unset_Type" = Unset, ) -> None: - """GsaSlimSearchMask - a model defined in Swagger + """GsaSlimPermission - a model defined in Swagger Parameters ---------- guid: str name: str - description: str | None, optional """ - self._description: str | None | Unset_Type = Unset self._name: str self._guid: str - if description is not Unset: - self.description = description self.name = name self.guid = guid - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaSlimSearchMask. - - Returns - ------- - str | None | Unset_Type - The description of this GsaSlimSearchMask. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaSlimSearchMask. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaSlimSearchMask. - """ - self._description = description - @property def name(self) -> "str": - """Gets the name of this GsaSlimSearchMask. + """Gets the name of this GsaSlimPermission. Returns ------- str - The name of this GsaSlimSearchMask. + The name of this GsaSlimPermission. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaSlimSearchMask. + """Sets the name of this GsaSlimPermission. Parameters ---------- name: str - The name of this GsaSlimSearchMask. + The name of this GsaSlimPermission. """ # Field is not nullable if name is None: @@ -152,23 +123,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaSlimSearchMask. + """Gets the guid of this GsaSlimPermission. Returns ------- str - The guid of this GsaSlimSearchMask. + The guid of this GsaSlimPermission. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimSearchMask. + """Sets the guid of this GsaSlimPermission. Parameters ---------- guid: str - The guid of this GsaSlimSearchMask. + The guid of this GsaSlimPermission. """ # Field is not nullable if guid is None: @@ -200,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimSearchMask): + if not isinstance(other, GsaSlimPermission): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_discrete_value.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission_category.py similarity index 75% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_discrete_value.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission_category.py index fb0361a4d..f614b11df 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_quality_discrete_value.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_permission_category.py @@ -42,7 +42,7 @@ from . import * -class GsaQualityDiscreteValue(ModelBase): +class GsaSlimPermissionCategory(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -63,13 +63,11 @@ class GsaQualityDiscreteValue(ModelBase): swagger_types: dict[str, str] = { "guid": "str", "name": "str", - "order": "int", } attribute_map: dict[str, str] = { "guid": "guid", "name": "name", - "order": "order", } subtype_mapping: dict[str, str] = {} @@ -81,71 +79,39 @@ def __init__( *, guid: "str", name: "str", - order: "int", ) -> None: - """GsaQualityDiscreteValue - a model defined in Swagger + """GsaSlimPermissionCategory - a model defined in Swagger Parameters ---------- guid: str name: str - order: int """ - self._order: int self._name: str self._guid: str - self.order = order self.name = name self.guid = guid - @property - def order(self) -> "int": - """Gets the order of this GsaQualityDiscreteValue. - - Returns - ------- - int - The order of this GsaQualityDiscreteValue. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaQualityDiscreteValue. - - Parameters - ---------- - order: int - The order of this GsaQualityDiscreteValue. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - @property def name(self) -> "str": - """Gets the name of this GsaQualityDiscreteValue. + """Gets the name of this GsaSlimPermissionCategory. Returns ------- str - The name of this GsaQualityDiscreteValue. + The name of this GsaSlimPermissionCategory. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaQualityDiscreteValue. + """Sets the name of this GsaSlimPermissionCategory. Parameters ---------- name: str - The name of this GsaQualityDiscreteValue. + The name of this GsaSlimPermissionCategory. """ # Field is not nullable if name is None: @@ -157,23 +123,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaQualityDiscreteValue. + """Gets the guid of this GsaSlimPermissionCategory. Returns ------- str - The guid of this GsaQualityDiscreteValue. + The guid of this GsaSlimPermissionCategory. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaQualityDiscreteValue. + """Sets the guid of this GsaSlimPermissionCategory. Parameters ---------- guid: str - The guid of this GsaQualityDiscreteValue. + The guid of this GsaSlimPermissionCategory. """ # Field is not nullable if guid is None: @@ -205,7 +171,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaQualityDiscreteValue): + if not isinstance(other, GsaSlimPermissionCategory): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_record_link_group.py index 161dfb7ca..7f4bfe06e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_record_link_group.py @@ -232,7 +232,6 @@ def reverse_display_names( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -244,7 +243,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimRecordLinkGroup. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_subset.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_subset.py index 4ec248e8c..54ffb3648 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_subset.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_subset.py @@ -102,7 +102,6 @@ def __init__( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -114,7 +113,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_table.py index b9bc687b0..3d7a1444b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_table.py @@ -61,7 +61,6 @@ class GsaSlimTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "database_key": "str", "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_browse": "bool", @@ -72,7 +71,6 @@ class GsaSlimTable(ModelBase): } attribute_map: dict[str, str] = { - "database_key": "databaseKey", "display_names": "displayNames", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", @@ -89,7 +87,6 @@ class GsaSlimTable(ModelBase): def __init__( self, *, - database_key: "str", display_names: "dict[str, str]", guid: "str", is_hidden_from_browse: "bool", @@ -102,7 +99,6 @@ def __init__( Parameters ---------- - database_key: str display_names: dict[str, str] guid: str is_hidden_from_browse: bool @@ -111,7 +107,6 @@ def __init__( name: str table_types: list[str] """ - self._database_key: str self._is_hidden_from_browse: bool self._is_hidden_from_search: bool self._is_versioned: bool @@ -120,7 +115,6 @@ def __init__( self._name: str self._guid: str - self.database_key = database_key self.is_hidden_from_browse = is_hidden_from_browse self.is_hidden_from_search = is_hidden_from_search self.is_versioned = is_versioned @@ -129,34 +123,6 @@ def __init__( self.name = name self.guid = guid - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaSlimTable. - - Returns - ------- - str - The database_key of this GsaSlimTable. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaSlimTable. - - Parameters - ---------- - database_key: str - The database_key of this GsaSlimTable. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - @property def is_hidden_from_browse(self) -> "bool": """Gets the is_hidden_from_browse of this GsaSlimTable. @@ -272,7 +238,6 @@ def table_types(self, table_types: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSlimTable. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -284,7 +249,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSlimTable. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_typed_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_typed_attribute.py index ce23a029b..25dedd3fd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_typed_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_typed_attribute.py @@ -61,14 +61,12 @@ class GsaSlimTypedAttribute(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", "guid": "str", "name": "str", "type": "GsaAttributeType", } attribute_map: dict[str, str] = { - "display_names": "displayNames", "guid": "guid", "name": "name", "type": "type", @@ -83,7 +81,6 @@ class GsaSlimTypedAttribute(ModelBase): def __init__( self, *, - display_names: "dict[str, str]", guid: "str", name: "str", type: "GsaAttributeType", @@ -92,18 +89,15 @@ def __init__( Parameters ---------- - display_names: dict[str, str] guid: str name: str type: GsaAttributeType """ self._type: GsaAttributeType - self._display_names: dict[str, str] self._name: str self._guid: str self.type = type - self.display_names = display_names self.name = name self.guid = guid @@ -135,36 +129,6 @@ def type(self, type: "GsaAttributeType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimTypedAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaSlimTypedAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimTypedAttribute. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaSlimTypedAttribute. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - @property def name(self) -> "str": """Gets the name of this GsaSlimTypedAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_localized_entity.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_unit_system.py similarity index 84% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_localized_entity.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_unit_system.py index 42839a879..b47c1ac33 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_localized_entity.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_slim_unit_system.py @@ -42,7 +42,7 @@ from . import * -class GsaSlimLocalizedEntity(ModelBase): +class GsaSlimUnitSystem(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -83,7 +83,7 @@ def __init__( guid: "str", name: "str", ) -> None: - """GsaSlimLocalizedEntity - a model defined in Swagger + """GsaSlimUnitSystem - a model defined in Swagger Parameters ---------- @@ -101,25 +101,23 @@ def __init__( @property def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaSlimLocalizedEntity. - A dictionary of the culture name to the name that should be used in that culture for the item + """Gets the display_names of this GsaSlimUnitSystem. Returns ------- dict[str, str] - The display_names of this GsaSlimLocalizedEntity. + The display_names of this GsaSlimUnitSystem. """ return self._display_names @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaSlimLocalizedEntity. - A dictionary of the culture name to the name that should be used in that culture for the item + """Sets the display_names of this GsaSlimUnitSystem. Parameters ---------- display_names: dict[str, str] - The display_names of this GsaSlimLocalizedEntity. + The display_names of this GsaSlimUnitSystem. """ # Field is not nullable if display_names is None: @@ -131,23 +129,23 @@ def display_names(self, display_names: "dict[str, str]") -> None: @property def name(self) -> "str": - """Gets the name of this GsaSlimLocalizedEntity. + """Gets the name of this GsaSlimUnitSystem. Returns ------- str - The name of this GsaSlimLocalizedEntity. + The name of this GsaSlimUnitSystem. """ return self._name @name.setter def name(self, name: "str") -> None: - """Sets the name of this GsaSlimLocalizedEntity. + """Sets the name of this GsaSlimUnitSystem. Parameters ---------- name: str - The name of this GsaSlimLocalizedEntity. + The name of this GsaSlimUnitSystem. """ # Field is not nullable if name is None: @@ -159,23 +157,23 @@ def name(self, name: "str") -> None: @property def guid(self) -> "str": - """Gets the guid of this GsaSlimLocalizedEntity. + """Gets the guid of this GsaSlimUnitSystem. Returns ------- str - The guid of this GsaSlimLocalizedEntity. + The guid of this GsaSlimUnitSystem. """ return self._guid @guid.setter def guid(self, guid: "str") -> None: - """Sets the guid of this GsaSlimLocalizedEntity. + """Sets the guid of this GsaSlimUnitSystem. Parameters ---------- guid: str - The guid of this GsaSlimLocalizedEntity. + The guid of this GsaSlimUnitSystem. """ # Field is not nullable if guid is None: @@ -207,7 +205,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaSlimLocalizedEntity): + if not isinstance(other, GsaSlimUnitSystem): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_detail.py deleted file mode 100644 index aa9ef157a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_detail.py +++ /dev/null @@ -1,201 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartAttributesErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaSmartAttributesErrorReason", - } - - discriminator_value_class_map = { - "attributeAlreadySpecified".lower(): "#/components/schemas/GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "attributePairDiscreteTypeMismatch".lower(): "#/components/schemas/GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "attributePairTypeMismatch".lower(): "#/components/schemas/GsaAttributePairTypeMismatchSmartAttributesErrorDetail", - "attributeTypeNotSupported".lower(): "#/components/schemas/GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "noAttributePairs".lower(): "#/components/schemas/GsaNoAttributePairsSmartAttributesErrorDetail", - "noSuchAttribute".lower(): "#/components/schemas/GsaNoSuchAttributeSmartAttributesErrorDetail", - "sourceCannotBeTarget".lower(): "#/components/schemas/GsaSourceCannotBeTargetSmartAttributesErrorDetail", - "tooManyAttributePairs".lower(): "#/components/schemas/GsaTooManyAttributePairsSmartAttributesErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason", - ) -> None: - """GsaSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - self._message: str - self._reason: GsaSmartAttributesErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaSmartAttributesErrorDetail. - - Returns - ------- - str - The message of this GsaSmartAttributesErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaSmartAttributesErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaSmartAttributesErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaSmartAttributesErrorReason": - """Gets the reason of this GsaSmartAttributesErrorDetail. - - Returns - ------- - GsaSmartAttributesErrorReason - The reason of this GsaSmartAttributesErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaSmartAttributesErrorReason") -> None: - """Sets the reason of this GsaSmartAttributesErrorDetail. - - Parameters - ---------- - reason: GsaSmartAttributesErrorReason - The reason of this GsaSmartAttributesErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_reason.py deleted file mode 100644 index 6033cfcf4..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_error_reason.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaSmartAttributesErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTEALREADYSPECIFIED = "attributeAlreadySpecified" - ATTRIBUTEPAIRDISCRETETYPEMISMATCH = "attributePairDiscreteTypeMismatch" - ATTRIBUTEPAIRTYPEMISMATCH = "attributePairTypeMismatch" - ATTRIBUTETYPENOTSUPPORTED = "attributeTypeNotSupported" - NOATTRIBUTEPAIRS = "noAttributePairs" - NOSUCHATTRIBUTE = "noSuchAttribute" - SOURCECANNOTBETARGET = "sourceCannotBeTarget" - TOOMANYATTRIBUTEPAIRS = "tooManyAttributePairs" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_record_link_group_error_detail.py deleted file mode 100644 index a2012b771..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_attributes_record_link_group_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartAttributesRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaSmartAttributesErrorDetail]", - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaSmartAttributesErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaSmartAttributesErrorDetail]", - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.SMARTATTRIBUTES, - ) -> None: - """GsaSmartAttributesRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaSmartAttributesErrorDetail] - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaSmartAttributesErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaSmartAttributesErrorDetail]": - """Gets the errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - - Returns - ------- - list[GsaSmartAttributesErrorDetail] - The errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaSmartAttributesErrorDetail]") -> None: - """Sets the errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - - Parameters - ---------- - errors: list[GsaSmartAttributesErrorDetail] - The errors of this GsaSmartAttributesRecordLinkGroupErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartAttributesRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link.py deleted file mode 100644 index 416ed0668..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link.py +++ /dev/null @@ -1,262 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "attribute_pairs": "list[GsaAttributeLinkPair]", - "display_names": "dict(str, str)", - "forbid_orphans": "bool", - "guid": "str", - "link_info": "GsaLinkInfo", - "name": "str", - "referential_integrity_model": "GsaReferentialIntegrityModel", - "reverse_name": "str", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "attribute_pairs": "attributePairs", - "display_names": "displayNames", - "forbid_orphans": "forbidOrphans", - "guid": "guid", - "link_info": "linkInfo", - "name": "name", - "referential_integrity_model": "referentialIntegrityModel", - "reverse_name": "reverseName", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = { - "referentialIntegrityModel": "GsaReferentialIntegrityModel", - "attributePairs": "GsaAttributeLinkPair", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - attribute_pairs: "list[GsaAttributeLinkPair]", - display_names: "dict[str, str]", - forbid_orphans: "bool", - guid: "str", - link_info: "GsaLinkInfo", - name: "str", - referential_integrity_model: "GsaReferentialIntegrityModel", - reverse_name: "str", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.SMARTLINK, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaSmartLink - a model defined in Swagger - - Parameters - ---------- - attribute_pairs: list[GsaAttributeLinkPair] - display_names: dict[str, str] - forbid_orphans: bool - guid: str - link_info: GsaLinkInfo - name: str - referential_integrity_model: GsaReferentialIntegrityModel - reverse_name: str - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._forbid_orphans: bool - self._referential_integrity_model: GsaReferentialIntegrityModel - self._attribute_pairs: list[GsaAttributeLinkPair] - - self.forbid_orphans = forbid_orphans - self.referential_integrity_model = referential_integrity_model - self.attribute_pairs = attribute_pairs - - @property - def forbid_orphans(self) -> "bool": - """Gets the forbid_orphans of this GsaSmartLink. - - Returns - ------- - bool - The forbid_orphans of this GsaSmartLink. - """ - return self._forbid_orphans - - @forbid_orphans.setter - def forbid_orphans(self, forbid_orphans: "bool") -> None: - """Sets the forbid_orphans of this GsaSmartLink. - - Parameters - ---------- - forbid_orphans: bool - The forbid_orphans of this GsaSmartLink. - """ - # Field is not nullable - if forbid_orphans is None: - raise ValueError("Invalid value for 'forbid_orphans', must not be 'None'") - # Field is required - if forbid_orphans is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'forbid_orphans', must not be 'Unset'") - self._forbid_orphans = forbid_orphans - - @property - def referential_integrity_model(self) -> "GsaReferentialIntegrityModel": - """Gets the referential_integrity_model of this GsaSmartLink. - - Returns - ------- - GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartLink. - """ - return self._referential_integrity_model - - @referential_integrity_model.setter - def referential_integrity_model( - self, referential_integrity_model: "GsaReferentialIntegrityModel" - ) -> None: - """Sets the referential_integrity_model of this GsaSmartLink. - - Parameters - ---------- - referential_integrity_model: GsaReferentialIntegrityModel - The referential_integrity_model of this GsaSmartLink. - """ - # Field is not nullable - if referential_integrity_model is None: - raise ValueError("Invalid value for 'referential_integrity_model', must not be 'None'") - # Field is required - if referential_integrity_model is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'referential_integrity_model', must not be 'Unset'") - self._referential_integrity_model = referential_integrity_model - - @property - def attribute_pairs(self) -> "list[GsaAttributeLinkPair]": - """Gets the attribute_pairs of this GsaSmartLink. - - Returns - ------- - list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartLink. - """ - return self._attribute_pairs - - @attribute_pairs.setter - def attribute_pairs(self, attribute_pairs: "list[GsaAttributeLinkPair]") -> None: - """Sets the attribute_pairs of this GsaSmartLink. - - Parameters - ---------- - attribute_pairs: list[GsaAttributeLinkPair] - The attribute_pairs of this GsaSmartLink. - """ - # Field is not nullable - if attribute_pairs is None: - raise ValueError("Invalid value for 'attribute_pairs', must not be 'None'") - # Field is required - if attribute_pairs is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'attribute_pairs', must not be 'Unset'") - self._attribute_pairs = attribute_pairs - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_create_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_create_put_layout_item.py deleted file mode 100644 index fd9fd01e7..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_create_put_layout_item.py +++ /dev/null @@ -1,196 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_create_put_layout_item import ( # noqa: F401 - GsaCreatePutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_new_layout_item_type import ( - GsaNewLayoutItemType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLinkCreatePutLayoutItem(GsaCreatePutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "item_type": "GsaNewLayoutItemType", - "link_group_guid": "str", - "type": "GsaPutType", - "forwards": "bool", - } - - attribute_map: dict[str, str] = { - "item_type": "itemType", - "link_group_guid": "linkGroupGuid", - "type": "type", - "forwards": "forwards", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - item_type: "GsaNewLayoutItemType" = GsaNewLayoutItemType.SMARTLINK, - link_group_guid: "str", - type: "GsaPutType" = GsaPutType.CREATE, - forwards: "bool | Unset_Type" = Unset, - ) -> None: - """GsaSmartLinkCreatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - item_type: GsaNewLayoutItemType - link_group_guid: str - type: GsaPutType - forwards: bool, optional - """ - super().__init__(item_type=item_type, type=type) - self._forwards: bool | Unset_Type = Unset - self._link_group_guid: str - - if forwards is not Unset: - self.forwards = forwards - self.link_group_guid = link_group_guid - - @property - def forwards(self) -> "bool | Unset_Type": - """Gets the forwards of this GsaSmartLinkCreatePutLayoutItem. - - Returns - ------- - bool | Unset_Type - The forwards of this GsaSmartLinkCreatePutLayoutItem. - """ - return self._forwards - - @forwards.setter - def forwards(self, forwards: "bool | Unset_Type") -> None: - """Sets the forwards of this GsaSmartLinkCreatePutLayoutItem. - - Parameters - ---------- - forwards: bool | Unset_Type - The forwards of this GsaSmartLinkCreatePutLayoutItem. - """ - # Field is not nullable - if forwards is None: - raise ValueError("Invalid value for 'forwards', must not be 'None'") - self._forwards = forwards - - @property - def link_group_guid(self) -> "str": - """Gets the link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - - Returns - ------- - str - The link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - """ - return self._link_group_guid - - @link_group_guid.setter - def link_group_guid(self, link_group_guid: "str") -> None: - """Sets the link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - - Parameters - ---------- - link_group_guid: str - The link_group_guid of this GsaSmartLinkCreatePutLayoutItem. - """ - # Field is not nullable - if link_group_guid is None: - raise ValueError("Invalid value for 'link_group_guid', must not be 'None'") - # Field is required - if link_group_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'link_group_guid', must not be 'Unset'") - self._link_group_guid = link_group_guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLinkCreatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_group_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_group_usage_data_modification_error_detail.py deleted file mode 100644 index c9561af75..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_link_group_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartLinkGroupUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.SMARTLINKGROUP, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaSmartLinkGroupUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaSmartLinkGroupUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartLinkGroupUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_result.py deleted file mode 100644 index f308e502e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smart_record_link_result.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSmartRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "is_link_to_target": "bool", - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - } - - attribute_map: dict[str, str] = { - "is_link_to_target": "isLinkToTarget", - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - is_link_to_target: "bool", - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, - ) -> None: - """GsaSmartRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - is_link_to_target: bool - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._is_link_to_target: bool - - self.is_link_to_target = is_link_to_target - - @property - def is_link_to_target(self) -> "bool": - """Gets the is_link_to_target of this GsaSmartRecordLinkResult. - Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.. - - Returns - ------- - bool - The is_link_to_target of this GsaSmartRecordLinkResult. - """ - return self._is_link_to_target - - @is_link_to_target.setter - def is_link_to_target(self, is_link_to_target: "bool") -> None: - """Sets the is_link_to_target of this GsaSmartRecordLinkResult. - Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.. - - Parameters - ---------- - is_link_to_target: bool - The is_link_to_target of this GsaSmartRecordLinkResult. - """ - # Field is not nullable - if is_link_to_target is None: - raise ValueError("Invalid value for 'is_link_to_target', must not be 'None'") - # Field is required - if is_link_to_target is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_link_to_target', must not be 'Unset'") - self._is_link_to_target = is_link_to_target - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSmartRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smtp_properties.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smtp_properties.py new file mode 100644 index 000000000..ca5dda211 --- /dev/null +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_smtp_properties.py @@ -0,0 +1,308 @@ +# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. +# SPDX-License-Identifier: MIT +# +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +""" +MI Server API + +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) + +OpenAPI spec version: v1 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import re # noqa: F401 +from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 + +from . import ModelBase, Unset, Unset_Type + +if TYPE_CHECKING: + from datetime import datetime + import pathlib + + from . import * + + +class GsaSmtpProperties(ModelBase): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes + ---------- + swagger_types: dict[str, str] + The key is attribute name and the value is attribute type. + attribute_map: dict[str, str] + The key is attribute name and the value is json key in definition. + subtype_mapping: dict[str, str] + The key is the unmangled property name and the value is the corresponding type. + discriminator: Optional[str] + Name of the property used as discriminator for subtypes. + """ + swagger_types: dict[str, str] = { + "authentication_password": "str", + "authentication_username": "str", + "host_name": "str", + "port": "int", + "use_authentication": "bool", + "use_ssl": "bool", + } + + attribute_map: dict[str, str] = { + "authentication_password": "authenticationPassword", + "authentication_username": "authenticationUsername", + "host_name": "hostName", + "port": "port", + "use_authentication": "useAuthentication", + "use_ssl": "useSsl", + } + + subtype_mapping: dict[str, str] = {} + + discriminator: Optional[str] = None + + def __init__( + self, + *, + authentication_password: "str | None | Unset_Type" = Unset, + authentication_username: "str | None | Unset_Type" = Unset, + host_name: "str | None | Unset_Type" = Unset, + port: "int | Unset_Type" = 25, + use_authentication: "bool | Unset_Type" = Unset, + use_ssl: "bool | Unset_Type" = Unset, + ) -> None: + """GsaSmtpProperties - a model defined in Swagger + + Parameters + ---------- + authentication_password: str | None, optional + authentication_username: str | None, optional + host_name: str | None, optional + port: int, optional + use_authentication: bool, optional + use_ssl: bool, optional + """ + self._host_name: str | None | Unset_Type = Unset + self._port: int | Unset_Type = Unset + self._use_ssl: bool | Unset_Type = Unset + self._use_authentication: bool | Unset_Type = Unset + self._authentication_username: str | None | Unset_Type = Unset + self._authentication_password: str | None | Unset_Type = Unset + + if host_name is not Unset: + self.host_name = host_name + if port is not Unset: + self.port = port + if use_ssl is not Unset: + self.use_ssl = use_ssl + if use_authentication is not Unset: + self.use_authentication = use_authentication + if authentication_username is not Unset: + self.authentication_username = authentication_username + if authentication_password is not Unset: + self.authentication_password = authentication_password + + @property + def host_name(self) -> "str | None | Unset_Type": + """Gets the host_name of this GsaSmtpProperties. + Gets or sets the name of the host used for SMTP transactions + + Returns + ------- + str | None | Unset_Type + The host_name of this GsaSmtpProperties. + """ + return self._host_name + + @host_name.setter + def host_name(self, host_name: "str | None | Unset_Type") -> None: + """Sets the host_name of this GsaSmtpProperties. + Gets or sets the name of the host used for SMTP transactions + + Parameters + ---------- + host_name: str | None | Unset_Type + The host_name of this GsaSmtpProperties. + """ + self._host_name = host_name + + @property + def port(self) -> "int | Unset_Type": + """Gets the port of this GsaSmtpProperties. + Gets or sets the port used for SMTP transactions. If no value set then it will default to 25 + + Returns + ------- + int | Unset_Type + The port of this GsaSmtpProperties. + """ + return self._port + + @port.setter + def port(self, port: "int | Unset_Type") -> None: + """Sets the port of this GsaSmtpProperties. + Gets or sets the port used for SMTP transactions. If no value set then it will default to 25 + + Parameters + ---------- + port: int | Unset_Type + The port of this GsaSmtpProperties. + """ + # Field is not nullable + if port is None: + raise ValueError("Invalid value for 'port', must not be 'None'") + self._port = port + + @property + def use_ssl(self) -> "bool | Unset_Type": + """Gets the use_ssl of this GsaSmtpProperties. + Indicates whether the SMTP server uses SSL. Defaults to False + + Returns + ------- + bool | Unset_Type + The use_ssl of this GsaSmtpProperties. + """ + return self._use_ssl + + @use_ssl.setter + def use_ssl(self, use_ssl: "bool | Unset_Type") -> None: + """Sets the use_ssl of this GsaSmtpProperties. + Indicates whether the SMTP server uses SSL. Defaults to False + + Parameters + ---------- + use_ssl: bool | Unset_Type + The use_ssl of this GsaSmtpProperties. + """ + # Field is not nullable + if use_ssl is None: + raise ValueError("Invalid value for 'use_ssl', must not be 'None'") + self._use_ssl = use_ssl + + @property + def use_authentication(self) -> "bool | Unset_Type": + """Gets the use_authentication of this GsaSmtpProperties. + Indicates whether authentication is required. If this is set to True then Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword are required. Defaults to False + + Returns + ------- + bool | Unset_Type + The use_authentication of this GsaSmtpProperties. + """ + return self._use_authentication + + @use_authentication.setter + def use_authentication(self, use_authentication: "bool | Unset_Type") -> None: + """Sets the use_authentication of this GsaSmtpProperties. + Indicates whether authentication is required. If this is set to True then Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword are required. Defaults to False + + Parameters + ---------- + use_authentication: bool | Unset_Type + The use_authentication of this GsaSmtpProperties. + """ + # Field is not nullable + if use_authentication is None: + raise ValueError("Invalid value for 'use_authentication', must not be 'None'") + self._use_authentication = use_authentication + + @property + def authentication_username(self) -> "str | None | Unset_Type": + """Gets the authentication_username of this GsaSmtpProperties. + Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Returns + ------- + str | None | Unset_Type + The authentication_username of this GsaSmtpProperties. + """ + return self._authentication_username + + @authentication_username.setter + def authentication_username(self, authentication_username: "str | None | Unset_Type") -> None: + """Sets the authentication_username of this GsaSmtpProperties. + Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Parameters + ---------- + authentication_username: str | None | Unset_Type + The authentication_username of this GsaSmtpProperties. + """ + self._authentication_username = authentication_username + + @property + def authentication_password(self) -> "str | None | Unset_Type": + """Gets the authentication_password of this GsaSmtpProperties. + Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Returns + ------- + str | None | Unset_Type + The authentication_password of this GsaSmtpProperties. + """ + return self._authentication_password + + @authentication_password.setter + def authentication_password(self, authentication_password: "str | None | Unset_Type") -> None: + """Sets the authentication_password of this GsaSmtpProperties. + Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True. + + Parameters + ---------- + authentication_password: str | None | Unset_Type + The authentication_password of this GsaSmtpProperties. + """ + self._authentication_password = authentication_password + + @classmethod + def get_real_child_model(cls, data: dict[str, str]) -> str: + """Raises a NotImplementedError for a type without a discriminator defined. + + Parameters + ---------- + data: ModelBase + Object representing a subclass of this class + + Raises + ------ + NotImplementedError + This class has no discriminator, and hence no subclasses + """ + raise NotImplementedError() + + def __repr__(self) -> str: + """For 'print' and 'pprint'""" + return self.to_str() + + def __eq__(self, other: Any) -> bool: + """Returns true if both objects are equal""" + if not isinstance(other, GsaSmtpProperties): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other: Any) -> bool: + """Returns true if both objects are not equal""" + return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py deleted file mode 100644 index d6f7dbe44..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_source_cannot_be_target_smart_attributes_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSourceCannotBeTargetSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.SOURCECANNOTBETARGET, - ) -> None: - """GsaSourceCannotBeTargetSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSourceCannotBeTargetSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_sql_credentials.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_sql_credentials.py deleted file mode 100644 index bf0be01aa..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_sql_credentials.py +++ /dev/null @@ -1,185 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSqlCredentials(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "password": "str", - "username": "str", - } - - attribute_map: dict[str, str] = { - "password": "password", - "username": "username", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - password: "str", - username: "str", - ) -> None: - """GsaSqlCredentials - a model defined in Swagger - - Parameters - ---------- - password: str - username: str - """ - self._username: str - self._password: str - - self.username = username - self.password = password - - @property - def username(self) -> "str": - """Gets the username of this GsaSqlCredentials. - The username for the SQL authentication. The password must also be provided. - - Returns - ------- - str - The username of this GsaSqlCredentials. - """ - return self._username - - @username.setter - def username(self, username: "str") -> None: - """Sets the username of this GsaSqlCredentials. - The username for the SQL authentication. The password must also be provided. - - Parameters - ---------- - username: str - The username of this GsaSqlCredentials. - """ - # Field is not nullable - if username is None: - raise ValueError("Invalid value for 'username', must not be 'None'") - # Field is required - if username is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'username', must not be 'Unset'") - self._username = username - - @property - def password(self) -> "str": - """Gets the password of this GsaSqlCredentials. - The password for the SQL authentication. The username must also be provided. - - Returns - ------- - str - The password of this GsaSqlCredentials. - """ - return self._password - - @password.setter - def password(self, password: "str") -> None: - """Sets the password of this GsaSqlCredentials. - The password for the SQL authentication. The username must also be provided. - - Parameters - ---------- - password: str - The password of this GsaSqlCredentials. - """ - # Field is not nullable - if password is None: - raise ValueError("Invalid value for 'password', must not be 'None'") - # Field is required - if password is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'password', must not be 'Unset'") - self._password = password - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSqlCredentials): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name.py index f94cd2f9b..e72caf795 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name.py @@ -65,7 +65,6 @@ class GsaStandardName(ModelBase): "database_key": "str", "database_version_guid": "str", "guid": "str", - "is_custom": "bool", "mapped_attributes": "list[GsaSlimAttribute]", "mapped_cross_database_record_link_groups": "list[GsaSlimNamedEntity]", "mapped_parameters": "list[GsaSlimNamedEntity]", @@ -78,7 +77,6 @@ class GsaStandardName(ModelBase): "database_key": "databaseKey", "database_version_guid": "databaseVersionGuid", "guid": "guid", - "is_custom": "isCustom", "mapped_attributes": "mappedAttributes", "mapped_cross_database_record_link_groups": "mappedCrossDatabaseRecordLinkGroups", "mapped_parameters": "mappedParameters", @@ -102,7 +100,6 @@ def __init__( database_key: "str", database_version_guid: "str", guid: "str", - is_custom: "bool", mapped_attributes: "list[GsaSlimAttribute]", mapped_cross_database_record_link_groups: "list[GsaSlimNamedEntity]", mapped_parameters: "list[GsaSlimNamedEntity]", @@ -117,7 +114,6 @@ def __init__( database_key: str database_version_guid: str guid: str - is_custom: bool mapped_attributes: list[GsaSlimAttribute] mapped_cross_database_record_link_groups: list[GsaSlimNamedEntity] mapped_parameters: list[GsaSlimNamedEntity] @@ -131,7 +127,6 @@ def __init__( self._database_key: str self._database_guid: str self._database_version_guid: str - self._is_custom: bool self._name: str self._guid: str @@ -142,7 +137,6 @@ def __init__( self.database_key = database_key self.database_guid = database_guid self.database_version_guid = database_version_guid - self.is_custom = is_custom self.name = name self.guid = guid @@ -350,34 +344,6 @@ def database_version_guid(self, database_version_guid: "str") -> None: raise ValueError("Invalid value for 'database_version_guid', must not be 'Unset'") self._database_version_guid = database_version_guid - @property - def is_custom(self) -> "bool": - """Gets the is_custom of this GsaStandardName. - - Returns - ------- - bool - The is_custom of this GsaStandardName. - """ - return self._is_custom - - @is_custom.setter - def is_custom(self, is_custom: "bool") -> None: - """Sets the is_custom of this GsaStandardName. - - Parameters - ---------- - is_custom: bool - The is_custom of this GsaStandardName. - """ - # Field is not nullable - if is_custom is None: - raise ValueError("Invalid value for 'is_custom', must not be 'None'") - # Field is required - if is_custom is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'is_custom', must not be 'Unset'") - self._is_custom = is_custom - @property def name(self) -> "str": """Gets the name of this GsaStandardName. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_already_exists_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_already_exists_error_detail.py deleted file mode 100644 index 7d5bb0a4c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_already_exists_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameAlreadyExistsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "standard_name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "standard_name": "standardName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.STANDARDNAMEALREADYEXISTS, - standard_name: "str", - ) -> None: - """GsaStandardNameAlreadyExistsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - standard_name: str - """ - super().__init__(message=message, reason=reason) - self._standard_name: str - - self.standard_name = standard_name - - @property - def standard_name(self) -> "str": - """Gets the standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - - Returns - ------- - str - The standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - """ - return self._standard_name - - @standard_name.setter - def standard_name(self, standard_name: "str") -> None: - """Sets the standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - - Parameters - ---------- - standard_name: str - The standard_name of this GsaStandardNameAlreadyExistsErrorDetail. - """ - # Field is not nullable - if standard_name is None: - raise ValueError("Invalid value for 'standard_name', must not be 'None'") - # Field is required - if standard_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'standard_name', must not be 'Unset'") - self._standard_name = standard_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameAlreadyExistsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_creation_exception.py deleted file mode 100644 index 0c6a81ab6..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_creation_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameCreationException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaStandardNameErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaStandardNameErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameCreationException. - - Returns - ------- - list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaStandardNameCreationException. - - Parameters - ---------- - errors: list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_detail.py deleted file mode 100644 index ec8882e32..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_detail.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameDeletionErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameDeletionErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaStandardNameDeletionErrorReason", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameDeletionErrorReason | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameDeletionErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameDeletionErrorReason, optional - """ - self._message: str - self._reason: GsaStandardNameDeletionErrorReason | Unset_Type = Unset - - self.message = message - if reason is not Unset: - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaStandardNameDeletionErrorDetail. - - Returns - ------- - str - The message of this GsaStandardNameDeletionErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaStandardNameDeletionErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaStandardNameDeletionErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaStandardNameDeletionErrorReason | Unset_Type": - """Gets the reason of this GsaStandardNameDeletionErrorDetail. - - Returns - ------- - GsaStandardNameDeletionErrorReason | Unset_Type - The reason of this GsaStandardNameDeletionErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaStandardNameDeletionErrorReason | Unset_Type") -> None: - """Sets the reason of this GsaStandardNameDeletionErrorDetail. - - Parameters - ---------- - reason: GsaStandardNameDeletionErrorReason | Unset_Type - The reason of this GsaStandardNameDeletionErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameDeletionErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_reason.py deleted file mode 100644 index d9d88a866..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_error_reason.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaStandardNameDeletionErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NONCUSTOMSTANDARDNAMECANNOTBEDELETED = "nonCustomStandardNameCannotBeDeleted" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_exception.py deleted file mode 100644 index 16ba151c9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_deletion_exception.py +++ /dev/null @@ -1,208 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameDeletionErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameDeletionErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameDeletionException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameDeletionErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameDeletionException. - - Returns - ------- - list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameDeletionException. - """ - return self._errors - - @errors.setter - def errors( - self, errors: "list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type" - ) -> None: - """Sets the errors of this GsaStandardNameDeletionException. - - Parameters - ---------- - errors: list[GsaStandardNameDeletionErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_detail.py deleted file mode 100644 index ddc336775..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_detail.py +++ /dev/null @@ -1,203 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaStandardNameErrorReason", - } - - discriminator_value_class_map = { - "standardNameAlreadyExists".lower(): "#/components/schemas/GsaStandardNameAlreadyExistsErrorDetail", - "duplicateMappedAttributeGuids".lower(): "#/components/schemas/GsaDuplicateMappedAttributeGuidsErrorDetail", - "duplicateMappedParameterGuids".lower(): "#/components/schemas/GsaDuplicateMappedParameterGuidsErrorDetail", - "duplicateMappedRecordLinkGroupGuids".lower(): "#/components/schemas/GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids".lower(): "#/components/schemas/GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "unresolvedAttributeGuids".lower(): "#/components/schemas/GsaUnresolvedAttributeGuidsErrorDetail", - "unresolvedParameterGuids".lower(): "#/components/schemas/GsaUnresolvedParameterGuidsErrorDetail", - "unresolvedRecordLinkGroupGuids".lower(): "#/components/schemas/GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "unresolvedCrossDatabaseRecordLinkGroupGuids".lower(): "#/components/schemas/GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "nonCustomStandardNameCannotBeChanged".lower(): "#/components/schemas/GsaNonCustomStandardNameCannotBeChangedErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason", - ) -> None: - """GsaStandardNameErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - """ - self._message: str - self._reason: GsaStandardNameErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaStandardNameErrorDetail. - - Returns - ------- - str - The message of this GsaStandardNameErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaStandardNameErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaStandardNameErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaStandardNameErrorReason": - """Gets the reason of this GsaStandardNameErrorDetail. - - Returns - ------- - GsaStandardNameErrorReason - The reason of this GsaStandardNameErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaStandardNameErrorReason") -> None: - """Sets the reason of this GsaStandardNameErrorDetail. - - Parameters - ---------- - reason: GsaStandardNameErrorReason - The reason of this GsaStandardNameErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_reason.py deleted file mode 100644 index c1c71b0b2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_error_reason.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaStandardNameErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - STANDARDNAMEALREADYEXISTS = "standardNameAlreadyExists" - DUPLICATEMAPPEDATTRIBUTEGUIDS = "duplicateMappedAttributeGuids" - DUPLICATEMAPPEDPARAMETERGUIDS = "duplicateMappedParameterGuids" - DUPLICATEMAPPEDRECORDLINKGROUPGUIDS = "duplicateMappedRecordLinkGroupGuids" - DUPLICATEMAPPEDCROSSDATABASERECORDLINKGROUPGUIDS = ( - "duplicateMappedCrossDatabaseRecordLinkGroupGuids" - ) - UNRESOLVEDATTRIBUTEGUIDS = "unresolvedAttributeGuids" - UNRESOLVEDPARAMETERGUIDS = "unresolvedParameterGuids" - UNRESOLVEDRECORDLINKGROUPGUIDS = "unresolvedRecordLinkGroupGuids" - UNRESOLVEDCROSSDATABASERECORDLINKGROUPGUIDS = "unresolvedCrossDatabaseRecordLinkGroupGuids" - NONCUSTOMSTANDARDNAMECANNOTBECHANGED = "nonCustomStandardNameCannotBeChanged" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_update_exception.py deleted file mode 100644 index 8faf34eeb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_standard_name_update_exception.py +++ /dev/null @@ -1,206 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStandardNameUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "list[GsaStandardNameErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaStandardNameErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStandardNameUpdateException - a model defined in Swagger - - Parameters - ---------- - code: GsaErrorCode, optional - errors: list[GsaStandardNameErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._errors: list[GsaStandardNameErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaStandardNameUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaStandardNameUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaStandardNameUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaStandardNameUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaStandardNameUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaStandardNameUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaStandardNameUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaStandardNameUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def errors(self) -> "list[GsaStandardNameErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaStandardNameUpdateException. - - Returns - ------- - list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaStandardNameErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaStandardNameUpdateException. - - Parameters - ---------- - errors: list[GsaStandardNameErrorDetail] | None | Unset_Type - The errors of this GsaStandardNameUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStandardNameUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link.py deleted file mode 100644 index 447544e61..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link.py +++ /dev/null @@ -1,146 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_base import ( # noqa: F401 - GsaRecordLinkBase, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStaticRecordLink(GsaRecordLinkBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "record_link_group_type": "GsaRecordLinkGroupType", - "source_record_history_guid": "str", - "target_record_history_guid": "str", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "record_link_group_type": "recordLinkGroupType", - "source_record_history_guid": "sourceRecordHistoryGuid", - "target_record_history_guid": "targetRecordHistoryGuid", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, - source_record_history_guid: "str", - target_record_history_guid: "str", - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStaticRecordLink - a model defined in Swagger - - Parameters - ---------- - guid: str - record_link_group_type: GsaRecordLinkGroupType - source_record_history_guid: str - target_record_history_guid: str - notes: str | None, optional - """ - super().__init__( - guid=guid, - record_link_group_type=record_link_group_type, - source_record_history_guid=source_record_history_guid, - target_record_history_guid=target_record_history_guid, - notes=notes, - ) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStaticRecordLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link_result.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link_result.py deleted file mode 100644 index 697051917..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_static_record_link_result.py +++ /dev/null @@ -1,158 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_type import ( - GsaRecordLinkGroupType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_result import ( # noqa: F401 - GsaRecordLinkResult, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaStaticRecordLinkResult(GsaRecordLinkResult): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "linked_record": "GsaSlimRecordVersion", - "record_link_group_type": "GsaRecordLinkGroupType", - "notes": "str", - } - - attribute_map: dict[str, str] = { - "linked_record": "linkedRecord", - "record_link_group_type": "recordLinkGroupType", - "notes": "notes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - linked_record: "GsaSlimRecordVersion", - record_link_group_type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.STATIC, - notes: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaStaticRecordLinkResult - a model defined in Swagger - - Parameters - ---------- - linked_record: GsaSlimRecordVersion - record_link_group_type: GsaRecordLinkGroupType - notes: str | None, optional - """ - super().__init__(linked_record=linked_record, record_link_group_type=record_link_group_type) - self._notes: str | None | Unset_Type = Unset - - if notes is not Unset: - self.notes = notes - - @property - def notes(self) -> "str | None | Unset_Type": - """Gets the notes of this GsaStaticRecordLinkResult. - - Returns - ------- - str | None | Unset_Type - The notes of this GsaStaticRecordLinkResult. - """ - return self._notes - - @notes.setter - def notes(self, notes: "str | None | Unset_Type") -> None: - """Sets the notes of this GsaStaticRecordLinkResult. - - Parameters - ---------- - notes: str | None | Unset_Type - The notes of this GsaStaticRecordLinkResult. - """ - self._notes = notes - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaStaticRecordLinkResult): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_subset.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_subset.py index 69edfb520..487a60060 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_subset.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_subset.py @@ -136,7 +136,6 @@ def associated_layout(self, associated_layout: "GsaSlimLayout | Unset_Type") -> @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -148,7 +147,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaSubset. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py deleted file mode 100644 index e18345a8d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_swap_name_and_reverse_name_circular_record_link_group_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_detail import ( # noqa: F401 - GsaRecordLinkGroupErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_record_link_group_error_reason import ( - GsaRecordLinkGroupErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail(GsaRecordLinkGroupErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaRecordLinkGroupErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaRecordLinkGroupErrorReason" = GsaRecordLinkGroupErrorReason.SWAPNAMEANDREVERSENAMECIRCULAR, - ) -> None: - """GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaRecordLinkGroupErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py deleted file mode 100644 index 096fe2252..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_symbol_cannot_contain_comma_unit_error_detail.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_detail import ( # noqa: F401 - GsaUnitErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_error_reason import GsaUnitErrorReason - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaSymbolCannotContainCommaUnitErrorDetail(GsaUnitErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason" = GsaUnitErrorReason.SYMBOLCANNOTCONTAINCOMMA, - symbol: "str", - ) -> None: - """GsaSymbolCannotContainCommaUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - - Returns - ------- - str - The symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaSymbolCannotContainCommaUnitErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaSymbolCannotContainCommaUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_t_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_t_item.py deleted file mode 100644 index bdac21057..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_t_item.py +++ /dev/null @@ -1,105 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTItem(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = {} - - attribute_map: dict[str, str] = {} - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - ) -> None: - """GsaTItem - a model defined in Swagger""" - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table.py index e03b3af67..c900138e1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table.py @@ -61,7 +61,6 @@ class GsaTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "database_key": "str", "display_names": "dict(str, str)", "guid": "str", "is_hidden_from_browse": "bool", @@ -69,21 +68,14 @@ class GsaTable(ModelBase): "is_versioned": "bool", "layouts": "list[GsaSlimLayout]", "name": "str", - "order": "int", "subsets": "list[GsaSlimSubset]", "table_types": "list[str]", "version_state": "GsaVersionState", - "datasheet_footer": "str", - "datasheet_header": "str", "default_layout": "GsaSlimLayout", "default_subset": "GsaSlimSubset", - "legal_disclaimer": "str", - "quality_system": "GsaSlimNamedEntity", - "should_show_version_control_signatures": "bool", } attribute_map: dict[str, str] = { - "database_key": "databaseKey", "display_names": "displayNames", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", @@ -91,17 +83,11 @@ class GsaTable(ModelBase): "is_versioned": "isVersioned", "layouts": "layouts", "name": "name", - "order": "order", "subsets": "subsets", "table_types": "tableTypes", "version_state": "versionState", - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "default_layout": "defaultLayout", "default_subset": "defaultSubset", - "legal_disclaimer": "legalDisclaimer", - "quality_system": "qualitySystem", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", } subtype_mapping: dict[str, str] = { @@ -110,7 +96,6 @@ class GsaTable(ModelBase): "defaultLayout": "GsaSlimLayout", "layouts": "GsaSlimLayout", "versionState": "GsaVersionState", - "qualitySystem": "GsaSlimNamedEntity", } discriminator: Optional[str] = None @@ -118,7 +103,6 @@ class GsaTable(ModelBase): def __init__( self, *, - database_key: "str", display_names: "dict[str, str]", guid: "str", is_hidden_from_browse: "bool", @@ -126,23 +110,16 @@ def __init__( is_versioned: "bool", layouts: "list[GsaSlimLayout]", name: "str", - order: "int", subsets: "list[GsaSlimSubset]", table_types: "list[str]", version_state: "GsaVersionState", - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, default_layout: "GsaSlimLayout | Unset_Type" = Unset, default_subset: "GsaSlimSubset | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, - quality_system: "GsaSlimNamedEntity | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, ) -> None: """GsaTable - a model defined in Swagger Parameters ---------- - database_key: str display_names: dict[str, str] guid: str is_hidden_from_browse: bool @@ -150,30 +127,17 @@ def __init__( is_versioned: bool layouts: list[GsaSlimLayout] name: str - order: int subsets: list[GsaSlimSubset] table_types: list[str] version_state: GsaVersionState - datasheet_footer: str | None, optional - datasheet_header: str | None, optional default_layout: GsaSlimLayout, optional default_subset: GsaSlimSubset, optional - legal_disclaimer: str | None, optional - quality_system: GsaSlimNamedEntity, optional - should_show_version_control_signatures: bool, optional """ self._default_subset: GsaSlimSubset | Unset_Type = Unset self._subsets: list[GsaSlimSubset] self._default_layout: GsaSlimLayout | Unset_Type = Unset self._layouts: list[GsaSlimLayout] self._version_state: GsaVersionState - self._order: int - self._quality_system: GsaSlimNamedEntity | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset - self._database_key: str self._is_hidden_from_browse: bool self._is_hidden_from_search: bool self._is_versioned: bool @@ -189,18 +153,6 @@ def __init__( self.default_layout = default_layout self.layouts = layouts self.version_state = version_state - self.order = order - if quality_system is not Unset: - self.quality_system = quality_system - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures - self.database_key = database_key self.is_hidden_from_browse = is_hidden_from_browse self.is_hidden_from_search = is_hidden_from_search self.is_versioned = is_versioned @@ -343,184 +295,6 @@ def version_state(self, version_state: "GsaVersionState") -> None: raise ValueError("Invalid value for 'version_state', must not be 'Unset'") self._version_state = version_state - @property - def order(self) -> "int": - """Gets the order of this GsaTable. - - Returns - ------- - int - The order of this GsaTable. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaTable. - - Parameters - ---------- - order: int - The order of this GsaTable. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - - @property - def quality_system(self) -> "GsaSlimNamedEntity | Unset_Type": - """Gets the quality_system of this GsaTable. - - Returns - ------- - GsaSlimNamedEntity | Unset_Type - The quality_system of this GsaTable. - """ - return self._quality_system - - @quality_system.setter - def quality_system(self, quality_system: "GsaSlimNamedEntity | Unset_Type") -> None: - """Sets the quality_system of this GsaTable. - - Parameters - ---------- - quality_system: GsaSlimNamedEntity | Unset_Type - The quality_system of this GsaTable. - """ - # Field is not nullable - if quality_system is None: - raise ValueError("Invalid value for 'quality_system', must not be 'None'") - self._quality_system = quality_system - - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaTable. - Gets or sets whether version control signatures should be shown when data is shown to a user. 'Version control signatures' show when a record was released, who released it and on which revision. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaTable. - Gets or sets whether version control signatures should be shown when data is shown to a user. 'Version control signatures' show when a record was released, who released it and on which revision. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaTable. - - Returns - ------- - str - The database_key of this GsaTable. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTable. - - Parameters - ---------- - database_key: str - The database_key of this GsaTable. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - @property def is_hidden_from_browse(self) -> "bool": """Gets the is_hidden_from_browse of this GsaTable. @@ -636,7 +410,6 @@ def table_types(self, table_types: "list[str]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaTable. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -648,7 +421,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaTable. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_creation_exception.py deleted file mode 100644 index 0251a4a8b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaTableErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaTableErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaTableErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaTableCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaTableErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaTableErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaTableCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaTableCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaTableCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaTableCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaTableCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaTableCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaTableCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaTableCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaTableCreationException. - - Returns - ------- - str - The name of this GsaTableCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaTableCreationException. - - Parameters - ---------- - name: str - The name of this GsaTableCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaTableErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaTableCreationException. - - Returns - ------- - list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaTableCreationException. - - Parameters - ---------- - errors: list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_deletion_exception.py index 02efb48bb..7c408146c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_deletion_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_deletion_exception.py @@ -61,21 +61,19 @@ class GsaTableDeletionException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaDataModificationErrorDetail]", "message": "str", } attribute_map: dict[str, str] = { - "guid": "guid", "code": "code", "errors": "errors", "message": "message", } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaDataModificationErrorDetail", } @@ -84,8 +82,7 @@ class GsaTableDeletionException(ModelBase): def __init__( self, *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -93,21 +90,18 @@ def __init__( Parameters ---------- - guid: str - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaDataModificationErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset if message is not Unset: self.message = message if code is not Unset: self.code = code - self.guid = guid if errors is not Unset: self.errors = errors @@ -134,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaTableDeletionException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaTableDeletionException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaTableDeletionException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaTableDeletionException. """ # Field is not nullable @@ -158,34 +152,6 @@ def code(self, code: "GsaErrorCode | Unset_Type") -> None: raise ValueError("Invalid value for 'code', must not be 'None'") self._code = code - @property - def guid(self) -> "str": - """Gets the guid of this GsaTableDeletionException. - - Returns - ------- - str - The guid of this GsaTableDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaTableDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaTableDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - @property def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": """Gets the errors of this GsaTableDeletionException. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_detail.py deleted file mode 100644 index 756282de5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaTableErrorReason", - } - - discriminator_value_class_map = { - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityTableErrorDetail", - "tableTypes".lower(): "#/components/schemas/GsaTableTypesErrorDetail", - "rootRecordNotAvailableToRename".lower(): "#/components/schemas/GsaRootRecordNotAvailableToRenameErrorDetail", - "defaultSubsetGuid".lower(): "#/components/schemas/GsaDefaultSubsetGuidErrorDetail", - "defaultLayoutGuid".lower(): "#/components/schemas/GsaDefaultLayoutGuidErrorDetail", - "qualitySystemGuid".lower(): "#/components/schemas/GsaQualitySystemGuidErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaTableErrorReason", - ) -> None: - """GsaTableErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableErrorReason - """ - self._message: str - self._reason: GsaTableErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaTableErrorDetail. - - Returns - ------- - str - The message of this GsaTableErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaTableErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaTableErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaTableErrorReason": - """Gets the reason of this GsaTableErrorDetail. - - Returns - ------- - GsaTableErrorReason - The reason of this GsaTableErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaTableErrorReason") -> None: - """Sets the reason of this GsaTableErrorDetail. - - Parameters - ---------- - reason: GsaTableErrorReason - The reason of this GsaTableErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_reason.py deleted file mode 100644 index 0ccf8c689..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NAMEDENTITY = "namedEntity" - TABLETYPES = "tableTypes" - ROOTRECORDNOTAVAILABLETORENAME = "rootRecordNotAvailableToRename" - DEFAULTSUBSETGUID = "defaultSubsetGuid" - DEFAULTLAYOUTGUID = "defaultLayoutGuid" - QUALITYSYSTEMGUID = "qualitySystemGuid" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_search_behaviour.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_search_behaviour.py deleted file mode 100644 index 35a64e183..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_search_behaviour.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableSearchBehaviour(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ONLYINCLUDERECORDSFROMSEARCHABLETABLES = "OnlyIncludeRecordsFromSearchableTables" - ONLYINCLUDERECORDSFROMHIDDENFROMSEARCHTABLES = "OnlyIncludeRecordsFromHiddenFromSearchTables" - INCLUDERECORDSFROMALLTABLES = "IncludeRecordsFromAllTables" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_contains_comma_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_contains_comma_error_detail.py deleted file mode 100644 index da8d1be89..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_contains_comma_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_type_error_detail import ( # noqa: F401 - GsaTableTypeErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_type_error_reason import ( - GsaTableTypeErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypeContainsCommaErrorDetail(GsaTableTypeErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - "table_type": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "table_type": "tableType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason" = GsaTableTypeErrorReason.TABLETYPECONTAINSCOMMA, - table_type: "str", - ) -> None: - """GsaTableTypeContainsCommaErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - table_type: str - """ - super().__init__(message=message, reason=reason) - self._table_type: str - - self.table_type = table_type - - @property - def table_type(self) -> "str": - """Gets the table_type of this GsaTableTypeContainsCommaErrorDetail. - - Returns - ------- - str - The table_type of this GsaTableTypeContainsCommaErrorDetail. - """ - return self._table_type - - @table_type.setter - def table_type(self, table_type: "str") -> None: - """Sets the table_type of this GsaTableTypeContainsCommaErrorDetail. - - Parameters - ---------- - table_type: str - The table_type of this GsaTableTypeContainsCommaErrorDetail. - """ - # Field is not nullable - if table_type is None: - raise ValueError("Invalid value for 'table_type', must not be 'None'") - # Field is required - if table_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_type', must not be 'Unset'") - self._table_type = table_type - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypeContainsCommaErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_detail.py deleted file mode 100644 index cde4389eb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_detail.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypeErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaTableTypeErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaTableTypeErrorReason", - } - - discriminator_value_class_map = { - "emptyTableType".lower(): "#/components/schemas/GsaEmptyTableTypeErrorDetail", - "tableTypeContainsComma".lower(): "#/components/schemas/GsaTableTypeContainsCommaErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaTableTypeErrorReason", - ) -> None: - """GsaTableTypeErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaTableTypeErrorReason - """ - self._message: str - self._reason: GsaTableTypeErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaTableTypeErrorDetail. - - Returns - ------- - str - The message of this GsaTableTypeErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaTableTypeErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaTableTypeErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaTableTypeErrorReason": - """Gets the reason of this GsaTableTypeErrorDetail. - - Returns - ------- - GsaTableTypeErrorReason - The reason of this GsaTableTypeErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaTableTypeErrorReason") -> None: - """Sets the reason of this GsaTableTypeErrorDetail. - - Parameters - ---------- - reason: GsaTableTypeErrorReason - The reason of this GsaTableTypeErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypeErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_reason.py deleted file mode 100644 index f452b84f5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_type_error_reason.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTableTypeErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EMPTYTABLETYPE = "emptyTableType" - TABLETYPECONTAINSCOMMA = "tableTypeContainsComma" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_error_detail.py deleted file mode 100644 index ff42bf544..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_error_detail.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_detail import ( # noqa: F401 - GsaTableErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_table_error_reason import ( - GsaTableErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypesErrorDetail(GsaTableErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaTableTypeErrorDetail]", - "message": "str", - "reason": "GsaTableErrorReason", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaTableTypeErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaTableTypeErrorDetail]", - message: "str", - reason: "GsaTableErrorReason" = GsaTableErrorReason.TABLETYPES, - ) -> None: - """GsaTableTypesErrorDetail - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaTableTypeErrorDetail] - message: str - reason: GsaTableErrorReason - """ - super().__init__(message=message, reason=reason) - self._errors: list[GsaTableTypeErrorDetail] - - self.errors = errors - - @property - def errors(self) -> "list[GsaTableTypeErrorDetail]": - """Gets the errors of this GsaTableTypesErrorDetail. - - Returns - ------- - list[GsaTableTypeErrorDetail] - The errors of this GsaTableTypesErrorDetail. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableTypeErrorDetail]") -> None: - """Sets the errors of this GsaTableTypesErrorDetail. - - Parameters - ---------- - errors: list[GsaTableTypeErrorDetail] - The errors of this GsaTableTypesErrorDetail. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_info.py deleted file mode 100644 index c8472451b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_types_info.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableTypesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_types": "list[str]", - } - - attribute_map: dict[str, str] = { - "table_types": "tableTypes", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_types: "list[str] | None | Unset_Type" = Unset, - ) -> None: - """GsaTableTypesInfo - a model defined in Swagger - - Parameters - ---------- - table_types: list[str] | None, optional - """ - self._table_types: list[str] | None | Unset_Type = Unset - - if table_types is not Unset: - self.table_types = table_types - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaTableTypesInfo. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaTableTypesInfo. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaTableTypesInfo. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaTableTypesInfo. - """ - self._table_types = table_types - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableTypesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_update_exception.py deleted file mode 100644 index bf21bdd3b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_table_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTableUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table_guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaTableErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "table_guid": "tableGuid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaTableErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table_guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaTableErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaTableUpdateException - a model defined in Swagger - - Parameters - ---------- - table_guid: str - code: GsaErrorCode, optional - errors: list[GsaTableErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._table_guid: str - self._errors: list[GsaTableErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.table_guid = table_guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaTableUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaTableUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaTableUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaTableUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaTableUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaTableUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaTableUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaTableUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def table_guid(self) -> "str": - """Gets the table_guid of this GsaTableUpdateException. - - Returns - ------- - str - The table_guid of this GsaTableUpdateException. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str") -> None: - """Sets the table_guid of this GsaTableUpdateException. - - Parameters - ---------- - table_guid: str - The table_guid of this GsaTableUpdateException. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - # Field is required - if table_guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table_guid', must not be 'Unset'") - self._table_guid = table_guid - - @property - def errors(self) -> "list[GsaTableErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaTableUpdateException. - - Returns - ------- - list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaTableErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaTableUpdateException. - - Parameters - ---------- - errors: list[GsaTableErrorDetail] | None | Unset_Type - The errors of this GsaTableUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTableUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute.py index 40e9b8619..c685569c1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute.py @@ -72,7 +72,6 @@ class GsaTabularAttribute(GsaAttribute): "hide_unlinked_rows": "bool", "info": "GsaAttributeInfo", "is_hidden_from_search_criteria": "bool", - "is_protected": "bool", "name": "str", "table": "GsaSlimEntity", "tabular_columns": "list[GsaTabularColumn]", @@ -92,7 +91,6 @@ class GsaTabularAttribute(GsaAttribute): "hide_unlinked_rows": "hideUnlinkedRows", "info": "info", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", - "is_protected": "isProtected", "name": "name", "table": "table", "tabular_columns": "tabularColumns", @@ -121,7 +119,6 @@ def __init__( hide_unlinked_rows: "bool", info: "GsaAttributeInfo", is_hidden_from_search_criteria: "bool", - is_protected: "bool", name: "str", table: "GsaSlimEntity", tabular_columns: "list[GsaTabularColumn]", @@ -143,7 +140,6 @@ def __init__( hide_unlinked_rows: bool info: GsaAttributeInfo is_hidden_from_search_criteria: bool - is_protected: bool name: str table: GsaSlimEntity tabular_columns: list[GsaTabularColumn] @@ -159,7 +155,6 @@ def __init__( guid=guid, info=info, is_hidden_from_search_criteria=is_hidden_from_search_criteria, - is_protected=is_protected, name=name, table=table, type=type, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute_link.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute_link.py deleted file mode 100644 index f2afbcafe..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_attribute_link.py +++ /dev/null @@ -1,191 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link import GsaLink # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_link_attribute_type import ( - GsaLinkAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTabularAttributeLink(GsaLink): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "link_info": "GsaLinkInfo", - "name": "str", - "reverse_name": "str", - "target_attribute": "GsaSlimEntity", - "type": "GsaLinkAttributeType", - "reverse_display_names": "dict(str, str)", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "link_info": "linkInfo", - "name": "name", - "reverse_name": "reverseName", - "target_attribute": "targetAttribute", - "type": "type", - "reverse_display_names": "reverseDisplayNames", - } - - subtype_mapping: dict[str, str] = { - "targetAttribute": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - link_info: "GsaLinkInfo", - name: "str", - reverse_name: "str", - target_attribute: "GsaSlimEntity", - type: "GsaLinkAttributeType" = GsaLinkAttributeType.TABULARATTRIBUTE, - reverse_display_names: "dict[str, str] | None | Unset_Type" = Unset, - ) -> None: - """GsaTabularAttributeLink - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - link_info: GsaLinkInfo - name: str - reverse_name: str - target_attribute: GsaSlimEntity - type: GsaLinkAttributeType - reverse_display_names: dict[str, str] | None, optional - """ - super().__init__( - display_names=display_names, - guid=guid, - link_info=link_info, - name=name, - reverse_name=reverse_name, - type=type, - reverse_display_names=reverse_display_names, - ) - self._target_attribute: GsaSlimEntity - - self.target_attribute = target_attribute - - @property - def target_attribute(self) -> "GsaSlimEntity": - """Gets the target_attribute of this GsaTabularAttributeLink. - - Returns - ------- - GsaSlimEntity - The target_attribute of this GsaTabularAttributeLink. - """ - return self._target_attribute - - @target_attribute.setter - def target_attribute(self, target_attribute: "GsaSlimEntity") -> None: - """Sets the target_attribute of this GsaTabularAttributeLink. - - Parameters - ---------- - target_attribute: GsaSlimEntity - The target_attribute of this GsaTabularAttributeLink. - """ - # Field is not nullable - if target_attribute is None: - raise ValueError("Invalid value for 'target_attribute', must not be 'None'") - # Field is required - if target_attribute is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_attribute', must not be 'Unset'") - self._target_attribute = target_attribute - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTabularAttributeLink): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column.py index 8a4a706a1..54d97685e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column.py @@ -67,13 +67,11 @@ class GsaTabularColumn(ModelBase): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -81,13 +79,11 @@ class GsaTabularColumn(ModelBase): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = { @@ -123,13 +119,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaTabularColumn - a model defined in Swagger @@ -139,20 +133,16 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ self._column_type: GsaTabularColumnDtoType self._show_as_link: bool self._summary_row_enabled: bool self._summary_row_text: str - self._summary_row_translations: dict[str, str] - self._order: int self._roll_up_type: GsaTabularColumnRollUpType self._summary_row_roll_up_type: GsaTabularColumnRollUpType self._display_names: dict[str, str] @@ -163,8 +153,6 @@ def __init__( self.show_as_link = show_as_link self.summary_row_enabled = summary_row_enabled self.summary_row_text = summary_row_text - self.summary_row_translations = summary_row_translations - self.order = order self.roll_up_type = roll_up_type self.summary_row_roll_up_type = summary_row_roll_up_type self.display_names = display_names @@ -283,66 +271,6 @@ def summary_row_text(self, summary_row_text: "str") -> None: raise ValueError("Invalid value for 'summary_row_text', must not be 'Unset'") self._summary_row_text = summary_row_text - @property - def summary_row_translations(self) -> "dict[str, str]": - """Gets the summary_row_translations of this GsaTabularColumn. - A dictionary of the culture name to the row text that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The summary_row_translations of this GsaTabularColumn. - """ - return self._summary_row_translations - - @summary_row_translations.setter - def summary_row_translations(self, summary_row_translations: "dict[str, str]") -> None: - """Sets the summary_row_translations of this GsaTabularColumn. - A dictionary of the culture name to the row text that should be used in that culture for the item - - Parameters - ---------- - summary_row_translations: dict[str, str] - The summary_row_translations of this GsaTabularColumn. - """ - # Field is not nullable - if summary_row_translations is None: - raise ValueError("Invalid value for 'summary_row_translations', must not be 'None'") - # Field is required - if summary_row_translations is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'summary_row_translations', must not be 'Unset'") - self._summary_row_translations = summary_row_translations - - @property - def order(self) -> "int": - """Gets the order of this GsaTabularColumn. - The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order. - - Returns - ------- - int - The order of this GsaTabularColumn. - """ - return self._order - - @order.setter - def order(self, order: "int") -> None: - """Sets the order of this GsaTabularColumn. - The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order. - - Parameters - ---------- - order: int - The order of this GsaTabularColumn. - """ - # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - # Field is required - if order is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'order', must not be 'Unset'") - self._order = order - @property def roll_up_type(self) -> "GsaTabularColumnRollUpType": """Gets the roll_up_type of this GsaTabularColumn. @@ -404,7 +332,6 @@ def summary_row_roll_up_type( @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaTabularColumn. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -416,7 +343,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaTabularColumn. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column_usage_data_modification_error_detail.py deleted file mode 100644 index c2434365f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_tabular_column_usage_data_modification_error_detail.py +++ /dev/null @@ -1,169 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTabularColumnUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaTabularAttributeWithColumns]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaTabularAttributeWithColumns", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.TABULARCOLUMN, - referenced_by: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" = Unset, - ) -> None: - """GsaTabularColumnUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaTabularAttributeWithColumns] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaTabularAttributeWithColumns] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaTabularAttributeWithColumns] | None | Unset_Type": - """Gets the referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaTabularAttributeWithColumns] | None | Unset_Type - The referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by( - self, referenced_by: "list[GsaTabularAttributeWithColumns] | None | Unset_Type" - ) -> None: - """Sets the referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaTabularAttributeWithColumns] | None | Unset_Type - The referenced_by of this GsaTabularColumnUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTabularColumnUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute.py deleted file mode 100644 index 4112e299a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute.py +++ /dev/null @@ -1,195 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTargetAttribute(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "target_type": "GsaTargetAttributeType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "target_type": "targetType", - } - - subtype_mapping: dict[str, str] = { - "targetType": "GsaTargetAttributeType", - } - - discriminator_value_class_map = { - "resolved".lower(): "#/components/schemas/GsaResolvedTargetAttribute", - "unresolved".lower(): "#/components/schemas/GsaUnresolvedTargetAttribute", - } - - discriminator: Optional[str] = "targetType" - - def __init__( - self, - *, - guid: "str", - target_type: "GsaTargetAttributeType", - ) -> None: - """GsaTargetAttribute - a model defined in Swagger - - Parameters - ---------- - guid: str - target_type: GsaTargetAttributeType - """ - self._target_type: GsaTargetAttributeType - self._guid: str - - self.target_type = target_type - self.guid = guid - - @property - def target_type(self) -> "GsaTargetAttributeType": - """Gets the target_type of this GsaTargetAttribute. - - Returns - ------- - GsaTargetAttributeType - The target_type of this GsaTargetAttribute. - """ - return self._target_type - - @target_type.setter - def target_type(self, target_type: "GsaTargetAttributeType") -> None: - """Sets the target_type of this GsaTargetAttribute. - - Parameters - ---------- - target_type: GsaTargetAttributeType - The target_type of this GsaTargetAttribute. - """ - # Field is not nullable - if target_type is None: - raise ValueError("Invalid value for 'target_type', must not be 'None'") - # Field is required - if target_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'target_type', must not be 'Unset'") - self._target_type = target_type - - @property - def guid(self) -> "str": - """Gets the guid of this GsaTargetAttribute. - - Returns - ------- - str - The guid of this GsaTargetAttribute. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaTargetAttribute. - - Parameters - ---------- - guid: str - The guid of this GsaTargetAttribute. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute_type.py deleted file mode 100644 index 9c00e2279..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_target_attribute_type.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaTargetAttributeType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - RESOLVED = "resolved" - UNRESOLVED = "unresolved" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_long_code_currency_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_long_code_currency_error_detail.py deleted file mode 100644 index 81ace96bb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_long_code_currency_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_detail import ( # noqa: F401 - GsaCurrencyErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_currency_error_reason import ( - GsaCurrencyErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooLongCodeCurrencyErrorDetail(GsaCurrencyErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaCurrencyErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaCurrencyErrorReason" = GsaCurrencyErrorReason.TOOLONGCODE, - ) -> None: - """GsaTooLongCodeCurrencyErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaCurrencyErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooLongCodeCurrencyErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py deleted file mode 100644 index bbe2a0ff2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_attribute_pairs_smart_attributes_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_detail import ( # noqa: F401 - GsaSmartAttributesErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_smart_attributes_error_reason import ( - GsaSmartAttributesErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyAttributePairsSmartAttributesErrorDetail(GsaSmartAttributesErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "number_of_attribute_pairs": "int", - "reason": "GsaSmartAttributesErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "number_of_attribute_pairs": "numberOfAttributePairs", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - number_of_attribute_pairs: "int", - reason: "GsaSmartAttributesErrorReason" = GsaSmartAttributesErrorReason.TOOMANYATTRIBUTEPAIRS, - ) -> None: - """GsaTooManyAttributePairsSmartAttributesErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - number_of_attribute_pairs: int - reason: GsaSmartAttributesErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_attribute_pairs: int - - self.number_of_attribute_pairs = number_of_attribute_pairs - - @property - def number_of_attribute_pairs(self) -> "int": - """Gets the number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - - Returns - ------- - int - The number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - """ - return self._number_of_attribute_pairs - - @number_of_attribute_pairs.setter - def number_of_attribute_pairs(self, number_of_attribute_pairs: "int") -> None: - """Sets the number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - - Parameters - ---------- - number_of_attribute_pairs: int - The number_of_attribute_pairs of this GsaTooManyAttributePairsSmartAttributesErrorDetail. - """ - # Field is not nullable - if number_of_attribute_pairs is None: - raise ValueError("Invalid value for 'number_of_attribute_pairs', must not be 'None'") - # Field is required - if number_of_attribute_pairs is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_attribute_pairs', must not be 'Unset'") - self._number_of_attribute_pairs = number_of_attribute_pairs - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyAttributePairsSmartAttributesErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_permission_category_error_detail.py deleted file mode 100644 index 0b52824cc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_permission_category_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_detail import ( # noqa: F401 - GsaPermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_permission_category_error_reason import ( - GsaPermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyPermissionsPermissionCategoryErrorDetail(GsaPermissionCategoryErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "number_of_new_permissions": "int", - "reason": "GsaPermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "number_of_new_permissions": "numberOfNewPermissions", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - number_of_new_permissions: "int", - reason: "GsaPermissionCategoryErrorReason" = GsaPermissionCategoryErrorReason.TOOMANYPERMISSIONS, - ) -> None: - """GsaTooManyPermissionsPermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - number_of_new_permissions: int - reason: GsaPermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_new_permissions: int - self._max_number_of_permissions: int - - self.number_of_new_permissions = number_of_new_permissions - self.max_number_of_permissions = max_number_of_permissions - - @property - def number_of_new_permissions(self) -> "int": - """Gets the number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - int - The number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - return self._number_of_new_permissions - - @number_of_new_permissions.setter - def number_of_new_permissions(self, number_of_new_permissions: "int") -> None: - """Sets the number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - number_of_new_permissions: int - The number_of_new_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if number_of_new_permissions is None: - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'None'") - # Field is required - if number_of_new_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'Unset'") - self._number_of_new_permissions = number_of_new_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaTooManyPermissionsPermissionCategoryErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyPermissionsPermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_replace_permission_category_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_replace_permission_category_error_detail.py deleted file mode 100644 index 8fb3a624d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_too_many_permissions_replace_permission_category_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_detail import ( # noqa: F401 - GsaReplacePermissionCategoryErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_replace_permission_category_error_reason import ( - GsaReplacePermissionCategoryErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTooManyPermissionsReplacePermissionCategoryErrorDetail( - GsaReplacePermissionCategoryErrorDetail -): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "max_number_of_permissions": "int", - "message": "str", - "number_of_new_permissions": "int", - "reason": "GsaReplacePermissionCategoryErrorReason", - } - - attribute_map: dict[str, str] = { - "max_number_of_permissions": "maxNumberOfPermissions", - "message": "message", - "number_of_new_permissions": "numberOfNewPermissions", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - max_number_of_permissions: "int", - message: "str", - number_of_new_permissions: "int", - reason: "GsaReplacePermissionCategoryErrorReason" = GsaReplacePermissionCategoryErrorReason.TOOMANYPERMISSIONS, - ) -> None: - """GsaTooManyPermissionsReplacePermissionCategoryErrorDetail - a model defined in Swagger - - Parameters - ---------- - max_number_of_permissions: int - message: str - number_of_new_permissions: int - reason: GsaReplacePermissionCategoryErrorReason - """ - super().__init__(message=message, reason=reason) - self._number_of_new_permissions: int - self._max_number_of_permissions: int - - self.number_of_new_permissions = number_of_new_permissions - self.max_number_of_permissions = max_number_of_permissions - - @property - def number_of_new_permissions(self) -> "int": - """Gets the number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Returns - ------- - int - The number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - return self._number_of_new_permissions - - @number_of_new_permissions.setter - def number_of_new_permissions(self, number_of_new_permissions: "int") -> None: - """Sets the number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - number_of_new_permissions: int - The number_of_new_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if number_of_new_permissions is None: - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'None'") - # Field is required - if number_of_new_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_of_new_permissions', must not be 'Unset'") - self._number_of_new_permissions = number_of_new_permissions - - @property - def max_number_of_permissions(self) -> "int": - """Gets the max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Returns - ------- - int - The max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - return self._max_number_of_permissions - - @max_number_of_permissions.setter - def max_number_of_permissions(self, max_number_of_permissions: "int") -> None: - """Sets the max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - - Parameters - ---------- - max_number_of_permissions: int - The max_number_of_permissions of this GsaTooManyPermissionsReplacePermissionCategoryErrorDetail. - """ - # Field is not nullable - if max_number_of_permissions is None: - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'None'") - # Field is required - if max_number_of_permissions is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'max_number_of_permissions', must not be 'Unset'") - self._max_number_of_permissions = max_number_of_permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTooManyPermissionsReplacePermissionCategoryErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_request.py index d92f6613b..2d0ea8b5d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_request.py @@ -64,7 +64,6 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "database_key": "str", "attributes": "list[GsaSlimEntity]", "constants": "list[GsaSlimEntity]", - "cross_database_link_groups": "list[GsaSlimEntity]", "data": "list[GsaSlimEntity]", "discrete_types": "list[GsaSlimEntity]", "discrete_values": "list[GsaSlimEntity]", @@ -74,12 +73,9 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "record_link_groups": "list[GsaSlimEntity]", "record_versions": "list[GsaSlimEntity]", "replacement_strings": "list[GsaSlimEntity]", - "search_masks": "list[GsaSlimEntity]", - "search_templates": "list[GsaSlimEntity]", "standard_names": "list[GsaSlimEntity]", "subsets": "list[GsaSlimEntity]", "tables": "list[GsaSlimEntity]", - "tabular_columns": "list[GsaSlimEntity]", "unit_systems": "list[GsaSlimEntity]", "units": "list[GsaSlimEntity]", } @@ -88,7 +84,6 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "database_key": "databaseKey", "attributes": "attributes", "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", "data": "data", "discrete_types": "discreteTypes", "discrete_values": "discreteValues", @@ -98,12 +93,9 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "record_link_groups": "recordLinkGroups", "record_versions": "recordVersions", "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", "standard_names": "standardNames", "subsets": "subsets", "tables": "tables", - "tabular_columns": "tabularColumns", "unit_systems": "unitSystems", "units": "units", } @@ -124,11 +116,7 @@ class GsaTranslateGuidsToIdentitiesRequest(ModelBase): "standardNames": "GsaSlimEntity", "constants": "GsaSlimEntity", "recordLinkGroups": "GsaSlimEntity", - "crossDatabaseLinkGroups": "GsaSlimEntity", - "tabularColumns": "GsaSlimEntity", "data": "GsaSlimEntity", - "searchMasks": "GsaSlimEntity", - "searchTemplates": "GsaSlimEntity", } discriminator: Optional[str] = None @@ -139,7 +127,6 @@ def __init__( database_key: "str", attributes: "list[GsaSlimEntity] | None | Unset_Type" = Unset, constants: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, data: "list[GsaSlimEntity] | None | Unset_Type" = Unset, discrete_types: "list[GsaSlimEntity] | None | Unset_Type" = Unset, discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, @@ -149,12 +136,9 @@ def __init__( record_link_groups: "list[GsaSlimEntity] | None | Unset_Type" = Unset, record_versions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, replacement_strings: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - search_masks: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - search_templates: "list[GsaSlimEntity] | None | Unset_Type" = Unset, standard_names: "list[GsaSlimEntity] | None | Unset_Type" = Unset, subsets: "list[GsaSlimEntity] | None | Unset_Type" = Unset, tables: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaSlimEntity] | None | Unset_Type" = Unset, unit_systems: "list[GsaSlimEntity] | None | Unset_Type" = Unset, units: "list[GsaSlimEntity] | None | Unset_Type" = Unset, ) -> None: @@ -165,7 +149,6 @@ def __init__( database_key: str attributes: list[GsaSlimEntity] | None, optional constants: list[GsaSlimEntity] | None, optional - cross_database_link_groups: list[GsaSlimEntity] | None, optional data: list[GsaSlimEntity] | None, optional discrete_types: list[GsaSlimEntity] | None, optional discrete_values: list[GsaSlimEntity] | None, optional @@ -175,12 +158,9 @@ def __init__( record_link_groups: list[GsaSlimEntity] | None, optional record_versions: list[GsaSlimEntity] | None, optional replacement_strings: list[GsaSlimEntity] | None, optional - search_masks: list[GsaSlimEntity] | None, optional - search_templates: list[GsaSlimEntity] | None, optional standard_names: list[GsaSlimEntity] | None, optional subsets: list[GsaSlimEntity] | None, optional tables: list[GsaSlimEntity] | None, optional - tabular_columns: list[GsaSlimEntity] | None, optional unit_systems: list[GsaSlimEntity] | None, optional units: list[GsaSlimEntity] | None, optional """ @@ -200,11 +180,7 @@ def __init__( self._standard_names: list[GsaSlimEntity] | None | Unset_Type = Unset self._constants: list[GsaSlimEntity] | None | Unset_Type = Unset self._record_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset - self._cross_database_link_groups: list[GsaSlimEntity] | None | Unset_Type = Unset - self._tabular_columns: list[GsaSlimEntity] | None | Unset_Type = Unset self._data: list[GsaSlimEntity] | None | Unset_Type = Unset - self._search_masks: list[GsaSlimEntity] | None | Unset_Type = Unset - self._search_templates: list[GsaSlimEntity] | None | Unset_Type = Unset self.database_key = database_key if attributes is not Unset: @@ -237,16 +213,8 @@ def __init__( self.constants = constants if record_link_groups is not Unset: self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns if data is not Unset: self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates @property def database_key(self) -> "str": @@ -610,52 +578,6 @@ def record_link_groups( """ self._record_link_groups = record_link_groups - @property - def cross_database_link_groups(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - cross_database_link_groups: list[GsaSlimEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns(self, tabular_columns: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - tabular_columns: list[GsaSlimEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._tabular_columns = tabular_columns - @property def data(self) -> "list[GsaSlimEntity] | None | Unset_Type": """Gets the data of this GsaTranslateGuidsToIdentitiesRequest. @@ -678,50 +600,6 @@ def data(self, data: "list[GsaSlimEntity] | None | Unset_Type") -> None: """ self._data = data - @property - def search_masks(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The search_masks of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - search_masks: list[GsaSlimEntity] | None | Unset_Type - The search_masks of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateGuidsToIdentitiesRequest. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The search_templates of this GsaTranslateGuidsToIdentitiesRequest. - """ - return self._search_templates - - @search_templates.setter - def search_templates(self, search_templates: "list[GsaSlimEntity] | None | Unset_Type") -> None: - """Sets the search_templates of this GsaTranslateGuidsToIdentitiesRequest. - - Parameters - ---------- - search_templates: list[GsaSlimEntity] | None | Unset_Type - The search_templates of this GsaTranslateGuidsToIdentitiesRequest. - """ - self._search_templates = search_templates - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_between_guids_and_identities_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_response.py similarity index 64% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_between_guids_and_identities_response.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_response.py index eb6ebe57a..9b34a5646 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_between_guids_and_identities_response.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_guids_to_identities_response.py @@ -42,7 +42,7 @@ from . import * -class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): +class GsaTranslateGuidsToIdentitiesResponse(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -64,7 +64,6 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "database_key": "str", "attributes": "list[GsaSlimIdentifiedEntity]", "constants": "list[GsaSlimIdentifiedEntity]", - "cross_database_link_groups": "list[GsaSlimIdentifiedEntity]", "data": "list[GsaSlimIdentifiedEntity]", "discrete_types": "list[GsaSlimIdentifiedEntity]", "discrete_values": "list[GsaSlimIdentifiedEntity]", @@ -74,12 +73,9 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "record_link_groups": "list[GsaSlimIdentifiedEntity]", "record_versions": "list[GsaSlimIdentifiedEntity]", "replacement_strings": "list[GsaSlimIdentifiedEntity]", - "search_masks": "list[GsaSlimIdentifiedEntity]", - "search_templates": "list[GsaSlimIdentifiedEntity]", "standard_names": "list[GsaSlimIdentifiedEntity]", "subsets": "list[GsaSlimIdentifiedEntity]", "tables": "list[GsaSlimIdentifiedEntity]", - "tabular_columns": "list[GsaSlimIdentifiedEntity]", "unit_systems": "list[GsaSlimIdentifiedEntity]", "units": "list[GsaSlimIdentifiedEntity]", } @@ -88,7 +84,6 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "database_key": "databaseKey", "attributes": "attributes", "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", "data": "data", "discrete_types": "discreteTypes", "discrete_values": "discreteValues", @@ -98,12 +93,9 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "record_link_groups": "recordLinkGroups", "record_versions": "recordVersions", "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", "standard_names": "standardNames", "subsets": "subsets", "tables": "tables", - "tabular_columns": "tabularColumns", "unit_systems": "unitSystems", "units": "units", } @@ -124,11 +116,7 @@ class GsaTranslateBetweenGuidsAndIdentitiesResponse(ModelBase): "standardNames": "GsaSlimIdentifiedEntity", "constants": "GsaSlimIdentifiedEntity", "recordLinkGroups": "GsaSlimIdentifiedEntity", - "crossDatabaseLinkGroups": "GsaSlimIdentifiedEntity", - "tabularColumns": "GsaSlimIdentifiedEntity", "data": "GsaSlimIdentifiedEntity", - "searchMasks": "GsaSlimIdentifiedEntity", - "searchTemplates": "GsaSlimIdentifiedEntity", } discriminator: Optional[str] = None @@ -139,7 +127,6 @@ def __init__( database_key: "str", attributes: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, constants: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, data: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, discrete_types: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, discrete_values: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, @@ -149,23 +136,19 @@ def __init__( record_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, record_versions: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, replacement_strings: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - search_masks: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - search_templates: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, standard_names: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, subsets: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, tables: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, - tabular_columns: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, unit_systems: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, units: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" = Unset, ) -> None: - """GsaTranslateBetweenGuidsAndIdentitiesResponse - a model defined in Swagger + """GsaTranslateGuidsToIdentitiesResponse - a model defined in Swagger Parameters ---------- database_key: str attributes: list[GsaSlimIdentifiedEntity] | None, optional constants: list[GsaSlimIdentifiedEntity] | None, optional - cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None, optional data: list[GsaSlimIdentifiedEntity] | None, optional discrete_types: list[GsaSlimIdentifiedEntity] | None, optional discrete_values: list[GsaSlimIdentifiedEntity] | None, optional @@ -175,12 +158,9 @@ def __init__( record_link_groups: list[GsaSlimIdentifiedEntity] | None, optional record_versions: list[GsaSlimIdentifiedEntity] | None, optional replacement_strings: list[GsaSlimIdentifiedEntity] | None, optional - search_masks: list[GsaSlimIdentifiedEntity] | None, optional - search_templates: list[GsaSlimIdentifiedEntity] | None, optional standard_names: list[GsaSlimIdentifiedEntity] | None, optional subsets: list[GsaSlimIdentifiedEntity] | None, optional tables: list[GsaSlimIdentifiedEntity] | None, optional - tabular_columns: list[GsaSlimIdentifiedEntity] | None, optional unit_systems: list[GsaSlimIdentifiedEntity] | None, optional units: list[GsaSlimIdentifiedEntity] | None, optional """ @@ -200,11 +180,7 @@ def __init__( self._standard_names: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._constants: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._record_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._tabular_columns: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self._data: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._search_masks: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset - self._search_templates: list[GsaSlimIdentifiedEntity] | None | Unset_Type = Unset self.database_key = database_key if attributes is not Unset: @@ -237,36 +213,28 @@ def __init__( self.constants = constants if record_link_groups is not Unset: self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns if data is not Unset: self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates @property def database_key(self) -> "str": - """Gets the database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the database_key of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- str - The database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The database_key of this GsaTranslateGuidsToIdentitiesResponse. """ return self._database_key @database_key.setter def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the database_key of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- database_key: str - The database_key of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The database_key of this GsaTranslateGuidsToIdentitiesResponse. """ # Field is not nullable if database_key is None: @@ -278,56 +246,56 @@ def database_key(self, database_key: "str") -> None: @property def attributes(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the attributes of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The attributes of this GsaTranslateGuidsToIdentitiesResponse. """ return self._attributes @attributes.setter def attributes(self, attributes: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the attributes of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- attributes: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The attributes of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The attributes of this GsaTranslateGuidsToIdentitiesResponse. """ self._attributes = attributes @property def layouts(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the layouts of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The layouts of this GsaTranslateGuidsToIdentitiesResponse. """ return self._layouts @layouts.setter def layouts(self, layouts: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the layouts of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- layouts: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The layouts of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The layouts of this GsaTranslateGuidsToIdentitiesResponse. """ self._layouts = layouts @property def record_versions(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_versions of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_versions of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_versions @@ -335,23 +303,23 @@ def record_versions(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type" def record_versions( self, record_versions: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_versions of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_versions: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_versions of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_versions of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_versions = record_versions @property def record_histories(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_histories of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_histories of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_histories @@ -359,45 +327,45 @@ def record_histories(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type def record_histories( self, record_histories: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_histories of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_histories: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_histories of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_histories of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_histories = record_histories @property def units(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the units of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The units of this GsaTranslateGuidsToIdentitiesResponse. """ return self._units @units.setter def units(self, units: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the units of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- units: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The units of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The units of this GsaTranslateGuidsToIdentitiesResponse. """ self._units = units @property def unit_systems(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the unit_systems of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The unit_systems of this GsaTranslateGuidsToIdentitiesResponse. """ return self._unit_systems @@ -405,89 +373,89 @@ def unit_systems(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def unit_systems( self, unit_systems: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the unit_systems of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- unit_systems: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The unit_systems of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The unit_systems of this GsaTranslateGuidsToIdentitiesResponse. """ self._unit_systems = unit_systems @property def parameters(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the parameters of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The parameters of this GsaTranslateGuidsToIdentitiesResponse. """ return self._parameters @parameters.setter def parameters(self, parameters: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the parameters of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- parameters: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The parameters of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The parameters of this GsaTranslateGuidsToIdentitiesResponse. """ self._parameters = parameters @property def subsets(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the subsets of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The subsets of this GsaTranslateGuidsToIdentitiesResponse. """ return self._subsets @subsets.setter def subsets(self, subsets: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the subsets of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- subsets: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The subsets of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The subsets of this GsaTranslateGuidsToIdentitiesResponse. """ self._subsets = subsets @property def tables(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the tables of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The tables of this GsaTranslateGuidsToIdentitiesResponse. """ return self._tables @tables.setter def tables(self, tables: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the tables of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- tables: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tables of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The tables of this GsaTranslateGuidsToIdentitiesResponse. """ self._tables = tables @property def discrete_types(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the discrete_types of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_types of this GsaTranslateGuidsToIdentitiesResponse. """ return self._discrete_types @@ -495,23 +463,23 @@ def discrete_types(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def discrete_types( self, discrete_types: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the discrete_types of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- discrete_types: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_types of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_types of this GsaTranslateGuidsToIdentitiesResponse. """ self._discrete_types = discrete_types @property def discrete_values(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the discrete_values of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_values of this GsaTranslateGuidsToIdentitiesResponse. """ return self._discrete_values @@ -519,23 +487,23 @@ def discrete_values(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type" def discrete_values( self, discrete_values: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the discrete_values of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- discrete_values: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The discrete_values of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The discrete_values of this GsaTranslateGuidsToIdentitiesResponse. """ self._discrete_values = discrete_values @property def replacement_strings(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. """ return self._replacement_strings @@ -543,23 +511,23 @@ def replacement_strings(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_T def replacement_strings( self, replacement_strings: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- replacement_strings: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The replacement_strings of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The replacement_strings of this GsaTranslateGuidsToIdentitiesResponse. """ self._replacement_strings = replacement_strings @property def standard_names(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the standard_names of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The standard_names of this GsaTranslateGuidsToIdentitiesResponse. """ return self._standard_names @@ -567,45 +535,45 @@ def standard_names(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": def standard_names( self, standard_names: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the standard_names of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- standard_names: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The standard_names of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The standard_names of this GsaTranslateGuidsToIdentitiesResponse. """ self._standard_names = standard_names @property def constants(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the constants of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The constants of this GsaTranslateGuidsToIdentitiesResponse. """ return self._constants @constants.setter def constants(self, constants: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the constants of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- constants: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The constants of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The constants of this GsaTranslateGuidsToIdentitiesResponse. """ self._constants = constants @property def record_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. """ return self._record_link_groups @@ -613,133 +581,37 @@ def record_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Ty def record_link_groups( self, record_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" ) -> None: - """Sets the record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- record_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The record_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The record_link_groups of this GsaTranslateGuidsToIdentitiesResponse. """ self._record_link_groups = record_link_groups - @property - def cross_database_link_groups(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - cross_database_link_groups: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns( - self, tabular_columns: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - tabular_columns: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The tabular_columns of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._tabular_columns = tabular_columns - @property def data(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Gets the data of this GsaTranslateGuidsToIdentitiesResponse. Returns ------- list[GsaSlimIdentifiedEntity] | None | Unset_Type - The data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The data of this GsaTranslateGuidsToIdentitiesResponse. """ return self._data @data.setter def data(self, data: "list[GsaSlimIdentifiedEntity] | None | Unset_Type") -> None: - """Sets the data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + """Sets the data of this GsaTranslateGuidsToIdentitiesResponse. Parameters ---------- data: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The data of this GsaTranslateBetweenGuidsAndIdentitiesResponse. + The data of this GsaTranslateGuidsToIdentitiesResponse. """ self._data = data - @property - def search_masks(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._search_masks - - @search_masks.setter - def search_masks( - self, search_masks: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - search_masks: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_masks of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[GsaSlimIdentifiedEntity] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Returns - ------- - list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - return self._search_templates - - @search_templates.setter - def search_templates( - self, search_templates: "list[GsaSlimIdentifiedEntity] | None | Unset_Type" - ) -> None: - """Sets the search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - - Parameters - ---------- - search_templates: list[GsaSlimIdentifiedEntity] | None | Unset_Type - The search_templates of this GsaTranslateBetweenGuidsAndIdentitiesResponse. - """ - self._search_templates = search_templates - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. @@ -762,7 +634,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaTranslateBetweenGuidsAndIdentitiesResponse): + if not isinstance(other, GsaTranslateGuidsToIdentitiesResponse): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_identities_to_guids_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_identities_to_guids_request.py deleted file mode 100644 index 8121ad074..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_translate_identities_to_guids_request.py +++ /dev/null @@ -1,729 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaTranslateIdentitiesToGuidsRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "database_key": "str", - "attributes": "list[int]", - "constants": "list[int]", - "cross_database_link_groups": "list[int]", - "data": "list[int]", - "discrete_types": "list[int]", - "discrete_values": "list[int]", - "layouts": "list[int]", - "parameters": "list[int]", - "record_histories": "list[int]", - "record_link_groups": "list[int]", - "record_versions": "list[int]", - "replacement_strings": "list[int]", - "search_masks": "list[int]", - "search_templates": "list[int]", - "standard_names": "list[int]", - "subsets": "list[int]", - "tables": "list[int]", - "tabular_columns": "list[int]", - "unit_systems": "list[int]", - "units": "list[int]", - } - - attribute_map: dict[str, str] = { - "database_key": "databaseKey", - "attributes": "attributes", - "constants": "constants", - "cross_database_link_groups": "crossDatabaseLinkGroups", - "data": "data", - "discrete_types": "discreteTypes", - "discrete_values": "discreteValues", - "layouts": "layouts", - "parameters": "parameters", - "record_histories": "recordHistories", - "record_link_groups": "recordLinkGroups", - "record_versions": "recordVersions", - "replacement_strings": "replacementStrings", - "search_masks": "searchMasks", - "search_templates": "searchTemplates", - "standard_names": "standardNames", - "subsets": "subsets", - "tables": "tables", - "tabular_columns": "tabularColumns", - "unit_systems": "unitSystems", - "units": "units", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - database_key: "str", - attributes: "list[int] | None | Unset_Type" = Unset, - constants: "list[int] | None | Unset_Type" = Unset, - cross_database_link_groups: "list[int] | None | Unset_Type" = Unset, - data: "list[int] | None | Unset_Type" = Unset, - discrete_types: "list[int] | None | Unset_Type" = Unset, - discrete_values: "list[int] | None | Unset_Type" = Unset, - layouts: "list[int] | None | Unset_Type" = Unset, - parameters: "list[int] | None | Unset_Type" = Unset, - record_histories: "list[int] | None | Unset_Type" = Unset, - record_link_groups: "list[int] | None | Unset_Type" = Unset, - record_versions: "list[int] | None | Unset_Type" = Unset, - replacement_strings: "list[int] | None | Unset_Type" = Unset, - search_masks: "list[int] | None | Unset_Type" = Unset, - search_templates: "list[int] | None | Unset_Type" = Unset, - standard_names: "list[int] | None | Unset_Type" = Unset, - subsets: "list[int] | None | Unset_Type" = Unset, - tables: "list[int] | None | Unset_Type" = Unset, - tabular_columns: "list[int] | None | Unset_Type" = Unset, - unit_systems: "list[int] | None | Unset_Type" = Unset, - units: "list[int] | None | Unset_Type" = Unset, - ) -> None: - """GsaTranslateIdentitiesToGuidsRequest - a model defined in Swagger - - Parameters - ---------- - database_key: str - attributes: list[int] | None, optional - constants: list[int] | None, optional - cross_database_link_groups: list[int] | None, optional - data: list[int] | None, optional - discrete_types: list[int] | None, optional - discrete_values: list[int] | None, optional - layouts: list[int] | None, optional - parameters: list[int] | None, optional - record_histories: list[int] | None, optional - record_link_groups: list[int] | None, optional - record_versions: list[int] | None, optional - replacement_strings: list[int] | None, optional - search_masks: list[int] | None, optional - search_templates: list[int] | None, optional - standard_names: list[int] | None, optional - subsets: list[int] | None, optional - tables: list[int] | None, optional - tabular_columns: list[int] | None, optional - unit_systems: list[int] | None, optional - units: list[int] | None, optional - """ - self._database_key: str - self._attributes: list[int] | None | Unset_Type = Unset - self._layouts: list[int] | None | Unset_Type = Unset - self._record_versions: list[int] | None | Unset_Type = Unset - self._record_histories: list[int] | None | Unset_Type = Unset - self._units: list[int] | None | Unset_Type = Unset - self._unit_systems: list[int] | None | Unset_Type = Unset - self._parameters: list[int] | None | Unset_Type = Unset - self._subsets: list[int] | None | Unset_Type = Unset - self._tables: list[int] | None | Unset_Type = Unset - self._discrete_types: list[int] | None | Unset_Type = Unset - self._discrete_values: list[int] | None | Unset_Type = Unset - self._replacement_strings: list[int] | None | Unset_Type = Unset - self._standard_names: list[int] | None | Unset_Type = Unset - self._constants: list[int] | None | Unset_Type = Unset - self._record_link_groups: list[int] | None | Unset_Type = Unset - self._cross_database_link_groups: list[int] | None | Unset_Type = Unset - self._tabular_columns: list[int] | None | Unset_Type = Unset - self._data: list[int] | None | Unset_Type = Unset - self._search_masks: list[int] | None | Unset_Type = Unset - self._search_templates: list[int] | None | Unset_Type = Unset - - self.database_key = database_key - if attributes is not Unset: - self.attributes = attributes - if layouts is not Unset: - self.layouts = layouts - if record_versions is not Unset: - self.record_versions = record_versions - if record_histories is not Unset: - self.record_histories = record_histories - if units is not Unset: - self.units = units - if unit_systems is not Unset: - self.unit_systems = unit_systems - if parameters is not Unset: - self.parameters = parameters - if subsets is not Unset: - self.subsets = subsets - if tables is not Unset: - self.tables = tables - if discrete_types is not Unset: - self.discrete_types = discrete_types - if discrete_values is not Unset: - self.discrete_values = discrete_values - if replacement_strings is not Unset: - self.replacement_strings = replacement_strings - if standard_names is not Unset: - self.standard_names = standard_names - if constants is not Unset: - self.constants = constants - if record_link_groups is not Unset: - self.record_link_groups = record_link_groups - if cross_database_link_groups is not Unset: - self.cross_database_link_groups = cross_database_link_groups - if tabular_columns is not Unset: - self.tabular_columns = tabular_columns - if data is not Unset: - self.data = data - if search_masks is not Unset: - self.search_masks = search_masks - if search_templates is not Unset: - self.search_templates = search_templates - - @property - def database_key(self) -> "str": - """Gets the database_key of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - str - The database_key of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._database_key - - @database_key.setter - def database_key(self, database_key: "str") -> None: - """Sets the database_key of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - database_key: str - The database_key of this GsaTranslateIdentitiesToGuidsRequest. - """ - # Field is not nullable - if database_key is None: - raise ValueError("Invalid value for 'database_key', must not be 'None'") - # Field is required - if database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'database_key', must not be 'Unset'") - self._database_key = database_key - - @property - def attributes(self) -> "list[int] | None | Unset_Type": - """Gets the attributes of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The attributes of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._attributes - - @attributes.setter - def attributes(self, attributes: "list[int] | None | Unset_Type") -> None: - """Sets the attributes of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - attributes: list[int] | None | Unset_Type - The attributes of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._attributes = attributes - - @property - def layouts(self) -> "list[int] | None | Unset_Type": - """Gets the layouts of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The layouts of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._layouts - - @layouts.setter - def layouts(self, layouts: "list[int] | None | Unset_Type") -> None: - """Sets the layouts of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - layouts: list[int] | None | Unset_Type - The layouts of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._layouts = layouts - - @property - def record_versions(self) -> "list[int] | None | Unset_Type": - """Gets the record_versions of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_versions of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_versions - - @record_versions.setter - def record_versions(self, record_versions: "list[int] | None | Unset_Type") -> None: - """Sets the record_versions of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_versions: list[int] | None | Unset_Type - The record_versions of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_versions = record_versions - - @property - def record_histories(self) -> "list[int] | None | Unset_Type": - """Gets the record_histories of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_histories of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_histories - - @record_histories.setter - def record_histories(self, record_histories: "list[int] | None | Unset_Type") -> None: - """Sets the record_histories of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_histories: list[int] | None | Unset_Type - The record_histories of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_histories = record_histories - - @property - def units(self) -> "list[int] | None | Unset_Type": - """Gets the units of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The units of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._units - - @units.setter - def units(self, units: "list[int] | None | Unset_Type") -> None: - """Sets the units of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - units: list[int] | None | Unset_Type - The units of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._units = units - - @property - def unit_systems(self) -> "list[int] | None | Unset_Type": - """Gets the unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._unit_systems - - @unit_systems.setter - def unit_systems(self, unit_systems: "list[int] | None | Unset_Type") -> None: - """Sets the unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - unit_systems: list[int] | None | Unset_Type - The unit_systems of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._unit_systems = unit_systems - - @property - def parameters(self) -> "list[int] | None | Unset_Type": - """Gets the parameters of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The parameters of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._parameters - - @parameters.setter - def parameters(self, parameters: "list[int] | None | Unset_Type") -> None: - """Sets the parameters of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - parameters: list[int] | None | Unset_Type - The parameters of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._parameters = parameters - - @property - def subsets(self) -> "list[int] | None | Unset_Type": - """Gets the subsets of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The subsets of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._subsets - - @subsets.setter - def subsets(self, subsets: "list[int] | None | Unset_Type") -> None: - """Sets the subsets of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - subsets: list[int] | None | Unset_Type - The subsets of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._subsets = subsets - - @property - def tables(self) -> "list[int] | None | Unset_Type": - """Gets the tables of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The tables of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._tables - - @tables.setter - def tables(self, tables: "list[int] | None | Unset_Type") -> None: - """Sets the tables of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - tables: list[int] | None | Unset_Type - The tables of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._tables = tables - - @property - def discrete_types(self) -> "list[int] | None | Unset_Type": - """Gets the discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._discrete_types - - @discrete_types.setter - def discrete_types(self, discrete_types: "list[int] | None | Unset_Type") -> None: - """Sets the discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - discrete_types: list[int] | None | Unset_Type - The discrete_types of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._discrete_types = discrete_types - - @property - def discrete_values(self) -> "list[int] | None | Unset_Type": - """Gets the discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._discrete_values - - @discrete_values.setter - def discrete_values(self, discrete_values: "list[int] | None | Unset_Type") -> None: - """Sets the discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - discrete_values: list[int] | None | Unset_Type - The discrete_values of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._discrete_values = discrete_values - - @property - def replacement_strings(self) -> "list[int] | None | Unset_Type": - """Gets the replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._replacement_strings - - @replacement_strings.setter - def replacement_strings(self, replacement_strings: "list[int] | None | Unset_Type") -> None: - """Sets the replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - replacement_strings: list[int] | None | Unset_Type - The replacement_strings of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._replacement_strings = replacement_strings - - @property - def standard_names(self) -> "list[int] | None | Unset_Type": - """Gets the standard_names of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The standard_names of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._standard_names - - @standard_names.setter - def standard_names(self, standard_names: "list[int] | None | Unset_Type") -> None: - """Sets the standard_names of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - standard_names: list[int] | None | Unset_Type - The standard_names of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._standard_names = standard_names - - @property - def constants(self) -> "list[int] | None | Unset_Type": - """Gets the constants of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The constants of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._constants - - @constants.setter - def constants(self, constants: "list[int] | None | Unset_Type") -> None: - """Sets the constants of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - constants: list[int] | None | Unset_Type - The constants of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._constants = constants - - @property - def record_link_groups(self) -> "list[int] | None | Unset_Type": - """Gets the record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._record_link_groups - - @record_link_groups.setter - def record_link_groups(self, record_link_groups: "list[int] | None | Unset_Type") -> None: - """Sets the record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - record_link_groups: list[int] | None | Unset_Type - The record_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._record_link_groups = record_link_groups - - @property - def cross_database_link_groups(self) -> "list[int] | None | Unset_Type": - """Gets the cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._cross_database_link_groups - - @cross_database_link_groups.setter - def cross_database_link_groups( - self, cross_database_link_groups: "list[int] | None | Unset_Type" - ) -> None: - """Sets the cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - cross_database_link_groups: list[int] | None | Unset_Type - The cross_database_link_groups of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._cross_database_link_groups = cross_database_link_groups - - @property - def tabular_columns(self) -> "list[int] | None | Unset_Type": - """Gets the tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._tabular_columns - - @tabular_columns.setter - def tabular_columns(self, tabular_columns: "list[int] | None | Unset_Type") -> None: - """Sets the tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - tabular_columns: list[int] | None | Unset_Type - The tabular_columns of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._tabular_columns = tabular_columns - - @property - def data(self) -> "list[int] | None | Unset_Type": - """Gets the data of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The data of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._data - - @data.setter - def data(self, data: "list[int] | None | Unset_Type") -> None: - """Sets the data of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - data: list[int] | None | Unset_Type - The data of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._data = data - - @property - def search_masks(self) -> "list[int] | None | Unset_Type": - """Gets the search_masks of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The search_masks of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._search_masks - - @search_masks.setter - def search_masks(self, search_masks: "list[int] | None | Unset_Type") -> None: - """Sets the search_masks of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - search_masks: list[int] | None | Unset_Type - The search_masks of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._search_masks = search_masks - - @property - def search_templates(self) -> "list[int] | None | Unset_Type": - """Gets the search_templates of this GsaTranslateIdentitiesToGuidsRequest. - - Returns - ------- - list[int] | None | Unset_Type - The search_templates of this GsaTranslateIdentitiesToGuidsRequest. - """ - return self._search_templates - - @search_templates.setter - def search_templates(self, search_templates: "list[int] | None | Unset_Type") -> None: - """Sets the search_templates of this GsaTranslateIdentitiesToGuidsRequest. - - Parameters - ---------- - search_templates: list[int] | None | Unset_Type - The search_templates of this GsaTranslateIdentitiesToGuidsRequest. - """ - self._search_templates = search_templates - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaTranslateIdentitiesToGuidsRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unavailable_tabular_column.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unavailable_tabular_column.py index 0ed0dc034..42b7a2df0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unavailable_tabular_column.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unavailable_tabular_column.py @@ -72,13 +72,11 @@ class GsaUnavailableTabularColumn(GsaTabularColumn): "display_names": "dict(str, str)", "guid": "str", "name": "str", - "order": "int", "roll_up_type": "GsaTabularColumnRollUpType", "show_as_link": "bool", "summary_row_enabled": "bool", "summary_row_roll_up_type": "GsaTabularColumnRollUpType", "summary_row_text": "str", - "summary_row_translations": "dict(str, str)", } attribute_map: dict[str, str] = { @@ -86,13 +84,11 @@ class GsaUnavailableTabularColumn(GsaTabularColumn): "display_names": "displayNames", "guid": "guid", "name": "name", - "order": "order", "roll_up_type": "rollUpType", "show_as_link": "showAsLink", "summary_row_enabled": "summaryRowEnabled", "summary_row_roll_up_type": "summaryRowRollUpType", "summary_row_text": "summaryRowText", - "summary_row_translations": "summaryRowTranslations", } subtype_mapping: dict[str, str] = {} @@ -106,13 +102,11 @@ def __init__( display_names: "dict[str, str]", guid: "str", name: "str", - order: "int", roll_up_type: "GsaTabularColumnRollUpType", show_as_link: "bool", summary_row_enabled: "bool", summary_row_roll_up_type: "GsaTabularColumnRollUpType", summary_row_text: "str", - summary_row_translations: "dict[str, str]", ) -> None: """GsaUnavailableTabularColumn - a model defined in Swagger @@ -122,26 +116,22 @@ def __init__( display_names: dict[str, str] guid: str name: str - order: int roll_up_type: GsaTabularColumnRollUpType show_as_link: bool summary_row_enabled: bool summary_row_roll_up_type: GsaTabularColumnRollUpType summary_row_text: str - summary_row_translations: dict[str, str] """ super().__init__( column_type=column_type, display_names=display_names, guid=guid, name=name, - order=order, roll_up_type=roll_up_type, show_as_link=show_as_link, summary_row_enabled=summary_row_enabled, summary_row_roll_up_type=summary_row_roll_up_type, summary_row_text=summary_row_text, - summary_row_translations=summary_row_translations, ) @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_as_exponent_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_as_exponent_unit_equation_error_detail.py deleted file mode 100644 index a0579bb73..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_as_exponent_unit_equation_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitAsExponentUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.UNITASEXPONENT, - ) -> None: - """GsaUnitAsExponentUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitAsExponentUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_conversion_set_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_conversion_set_request.py index d50e77af0..c265493c1 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_conversion_set_request.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_conversion_set_request.py @@ -96,7 +96,6 @@ def __init__( @property def source_unit_symbol(self) -> "str": """Gets the source_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Returns ------- @@ -108,7 +107,6 @@ def source_unit_symbol(self) -> "str": @source_unit_symbol.setter def source_unit_symbol(self, source_unit_symbol: "str") -> None: """Sets the source_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Parameters ---------- @@ -126,7 +124,6 @@ def source_unit_symbol(self, source_unit_symbol: "str") -> None: @property def target_unit_symbol(self) -> "str": """Gets the target_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Returns ------- @@ -138,7 +135,6 @@ def target_unit_symbol(self) -> "str": @target_unit_symbol.setter def target_unit_symbol(self, target_unit_symbol: "str") -> None: """Sets the target_unit_symbol of this GsaUnitConversionSetRequest. - Symbol of the unit to convert from If the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_creation_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_creation_exception.py deleted file mode 100644 index 084b8bd7c..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_creation_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitCreationException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "name": "str", - "code": "GsaErrorCode", - "errors": "list[GsaUnitErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "name": "name", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - name: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitCreationException - a model defined in Swagger - - Parameters - ---------- - name: str - code: GsaErrorCode, optional - errors: list[GsaUnitErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._name: str - self._errors: list[GsaUnitErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.name = name - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUnitCreationException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUnitCreationException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUnitCreationException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUnitCreationException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUnitCreationException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUnitCreationException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUnitCreationException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUnitCreationException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def name(self) -> "str": - """Gets the name of this GsaUnitCreationException. - - Returns - ------- - str - The name of this GsaUnitCreationException. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaUnitCreationException. - - Parameters - ---------- - name: str - The name of this GsaUnitCreationException. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def errors(self) -> "list[GsaUnitErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUnitCreationException. - - Returns - ------- - list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitCreationException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUnitCreationException. - - Parameters - ---------- - errors: list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitCreationException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitCreationException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_deletion_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_deletion_exception.py deleted file mode 100644 index 9e25a97b9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_deletion_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitDeletionException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaDataModificationErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaDataModificationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitDeletionException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaDataModificationErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaDataModificationErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUnitDeletionException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUnitDeletionException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUnitDeletionException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUnitDeletionException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUnitDeletionException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUnitDeletionException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUnitDeletionException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUnitDeletionException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUnitDeletionException. - - Returns - ------- - str - The guid of this GsaUnitDeletionException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUnitDeletionException. - - Parameters - ---------- - guid: str - The guid of this GsaUnitDeletionException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaDataModificationErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUnitDeletionException. - - Returns - ------- - list[GsaDataModificationErrorDetail] | None | Unset_Type - The errors of this GsaUnitDeletionException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaDataModificationErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUnitDeletionException. - - Parameters - ---------- - errors: list[GsaDataModificationErrorDetail] | None | Unset_Type - The errors of this GsaUnitDeletionException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitDeletionException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_detail.py deleted file mode 100644 index 28e551534..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_detail.py +++ /dev/null @@ -1,199 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitEquationErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitEquationErrorReason", - } - - discriminator_value_class_map = { - "general".lower(): "#/components/schemas/GsaGeneralUnitEquationErrorDetail", - "unknownUnitSymbol".lower(): "#/components/schemas/GsaUnknownUnitSymbolUnitEquationErrorDetail", - "bracketMismatch".lower(): "#/components/schemas/GsaBracketMismatchUnitEquationErrorDetail", - "numberParsing".lower(): "#/components/schemas/GsaNumberParsingUnitEquationErrorDetail", - "unitAsExponent".lower(): "#/components/schemas/GsaUnitAsExponentUnitEquationErrorDetail", - "divideByZero".lower(): "#/components/schemas/GsaDivideByZeroUnitEquationErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason", - ) -> None: - """GsaUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - """ - self._message: str - self._reason: GsaUnitEquationErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitEquationErrorDetail. - - Returns - ------- - str - The message of this GsaUnitEquationErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitEquationErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitEquationErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitEquationErrorReason": - """Gets the reason of this GsaUnitEquationErrorDetail. - - Returns - ------- - GsaUnitEquationErrorReason - The reason of this GsaUnitEquationErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitEquationErrorReason") -> None: - """Sets the reason of this GsaUnitEquationErrorDetail. - - Parameters - ---------- - reason: GsaUnitEquationErrorReason - The reason of this GsaUnitEquationErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_reason.py deleted file mode 100644 index dee4c5f91..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equation_error_reason.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitEquationErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - GENERAL = "general" - UNKNOWNUNITSYMBOL = "unknownUnitSymbol" - BRACKETMISMATCH = "bracketMismatch" - NUMBERPARSING = "numberParsing" - UNITASEXPONENT = "unitAsExponent" - DIVIDEBYZERO = "divideByZero" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent.py index e0c4ef508..631b495f7 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent.py @@ -61,9 +61,9 @@ class GsaUnitEquivalent(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "equivalent_unit": "GsaSlimUnit", - "unit": "GsaSlimEntity", - "unit_system": "GsaSlimEntity", + "equivalent_unit": "GsaUnit", + "unit": "GsaUnit", + "unit_system": "GsaUnitSystem", } attribute_map: dict[str, str] = { @@ -73,9 +73,9 @@ class GsaUnitEquivalent(ModelBase): } subtype_mapping: dict[str, str] = { - "unit": "GsaSlimEntity", - "unitSystem": "GsaSlimEntity", - "equivalentUnit": "GsaSlimUnit", + "unit": "GsaUnit", + "unitSystem": "GsaUnitSystem", + "equivalentUnit": "GsaUnit", } discriminator: Optional[str] = None @@ -83,44 +83,44 @@ class GsaUnitEquivalent(ModelBase): def __init__( self, *, - equivalent_unit: "GsaSlimUnit", - unit: "GsaSlimEntity", - unit_system: "GsaSlimEntity", + equivalent_unit: "GsaUnit", + unit: "GsaUnit", + unit_system: "GsaUnitSystem", ) -> None: """GsaUnitEquivalent - a model defined in Swagger Parameters ---------- - equivalent_unit: GsaSlimUnit - unit: GsaSlimEntity - unit_system: GsaSlimEntity + equivalent_unit: GsaUnit + unit: GsaUnit + unit_system: GsaUnitSystem """ - self._unit: GsaSlimEntity - self._unit_system: GsaSlimEntity - self._equivalent_unit: GsaSlimUnit + self._unit: GsaUnit + self._unit_system: GsaUnitSystem + self._equivalent_unit: GsaUnit self.unit = unit self.unit_system = unit_system self.equivalent_unit = equivalent_unit @property - def unit(self) -> "GsaSlimEntity": + def unit(self) -> "GsaUnit": """Gets the unit of this GsaUnitEquivalent. Returns ------- - GsaSlimEntity + GsaUnit The unit of this GsaUnitEquivalent. """ return self._unit @unit.setter - def unit(self, unit: "GsaSlimEntity") -> None: + def unit(self, unit: "GsaUnit") -> None: """Sets the unit of this GsaUnitEquivalent. Parameters ---------- - unit: GsaSlimEntity + unit: GsaUnit The unit of this GsaUnitEquivalent. """ # Field is not nullable @@ -132,23 +132,23 @@ def unit(self, unit: "GsaSlimEntity") -> None: self._unit = unit @property - def unit_system(self) -> "GsaSlimEntity": + def unit_system(self) -> "GsaUnitSystem": """Gets the unit_system of this GsaUnitEquivalent. Returns ------- - GsaSlimEntity + GsaUnitSystem The unit_system of this GsaUnitEquivalent. """ return self._unit_system @unit_system.setter - def unit_system(self, unit_system: "GsaSlimEntity") -> None: + def unit_system(self, unit_system: "GsaUnitSystem") -> None: """Sets the unit_system of this GsaUnitEquivalent. Parameters ---------- - unit_system: GsaSlimEntity + unit_system: GsaUnitSystem The unit_system of this GsaUnitEquivalent. """ # Field is not nullable @@ -160,23 +160,23 @@ def unit_system(self, unit_system: "GsaSlimEntity") -> None: self._unit_system = unit_system @property - def equivalent_unit(self) -> "GsaSlimUnit": + def equivalent_unit(self) -> "GsaUnit": """Gets the equivalent_unit of this GsaUnitEquivalent. Returns ------- - GsaSlimUnit + GsaUnit The equivalent_unit of this GsaUnitEquivalent. """ return self._equivalent_unit @equivalent_unit.setter - def equivalent_unit(self, equivalent_unit: "GsaSlimUnit") -> None: + def equivalent_unit(self, equivalent_unit: "GsaUnit") -> None: """Sets the equivalent_unit of this GsaUnitEquivalent. Parameters ---------- - equivalent_unit: GsaSlimUnit + equivalent_unit: GsaUnit The equivalent_unit of this GsaUnitEquivalent. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_detail.py deleted file mode 100644 index ba4292497..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_detail.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitEquivalentErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquivalentErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitEquivalentErrorReason", - } - - discriminator_value_class_map = { - "noSuchUnit".lower(): "#/components/schemas/GsaNoSuchUnitUnitEquivalentErrorDetail", - "noSuchUnitSystem".lower(): "#/components/schemas/GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "incompatibleUnits".lower(): "#/components/schemas/GsaIncompatibleUnitsErrorDetail", - "invalidEquivalenceTarget".lower(): "#/components/schemas/GsaInvalidEquivalenceTargetErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquivalentErrorReason", - ) -> None: - """GsaUnitEquivalentErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquivalentErrorReason - """ - self._message: str - self._reason: GsaUnitEquivalentErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitEquivalentErrorDetail. - - Returns - ------- - str - The message of this GsaUnitEquivalentErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitEquivalentErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitEquivalentErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitEquivalentErrorReason": - """Gets the reason of this GsaUnitEquivalentErrorDetail. - - Returns - ------- - GsaUnitEquivalentErrorReason - The reason of this GsaUnitEquivalentErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitEquivalentErrorReason") -> None: - """Sets the reason of this GsaUnitEquivalentErrorDetail. - - Parameters - ---------- - reason: GsaUnitEquivalentErrorReason - The reason of this GsaUnitEquivalentErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitEquivalentErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_reason.py deleted file mode 100644 index 837043f34..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_equivalent_error_reason.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitEquivalentErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - NOSUCHUNIT = "noSuchUnit" - NOSUCHUNITSYSTEM = "noSuchUnitSystem" - INCOMPATIBLEUNITS = "incompatibleUnits" - INVALIDEQUIVALENCETARGET = "invalidEquivalenceTarget" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_detail.py deleted file mode 100644 index e4e972802..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_detail.py +++ /dev/null @@ -1,198 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitErrorDetail(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = { - "reason": "GsaUnitErrorReason", - } - - discriminator_value_class_map = { - "emptySymbol".lower(): "#/components/schemas/GsaEmptySymbolUnitErrorDetail", - "duplicateSymbol".lower(): "#/components/schemas/GsaDuplicateSymbolUnitErrorDetail", - "symbolCannotContainComma".lower(): "#/components/schemas/GsaSymbolCannotContainCommaUnitErrorDetail", - "namedEntity".lower(): "#/components/schemas/GsaNamedEntityUnitErrorDetail", - "equation".lower(): "#/components/schemas/GsaEquationUnitErrorDetail", - } - - discriminator: Optional[str] = "reason" - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitErrorReason", - ) -> None: - """GsaUnitErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitErrorReason - """ - self._message: str - self._reason: GsaUnitErrorReason - - self.message = message - self.reason = reason - - @property - def message(self) -> "str": - """Gets the message of this GsaUnitErrorDetail. - - Returns - ------- - str - The message of this GsaUnitErrorDetail. - """ - return self._message - - @message.setter - def message(self, message: "str") -> None: - """Sets the message of this GsaUnitErrorDetail. - - Parameters - ---------- - message: str - The message of this GsaUnitErrorDetail. - """ - # Field is not nullable - if message is None: - raise ValueError("Invalid value for 'message', must not be 'None'") - # Field is required - if message is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'message', must not be 'Unset'") - self._message = message - - @property - def reason(self) -> "GsaUnitErrorReason": - """Gets the reason of this GsaUnitErrorDetail. - - Returns - ------- - GsaUnitErrorReason - The reason of this GsaUnitErrorDetail. - """ - return self._reason - - @reason.setter - def reason(self, reason: "GsaUnitErrorReason") -> None: - """Sets the reason of this GsaUnitErrorDetail. - - Parameters - ---------- - reason: GsaUnitErrorReason - The reason of this GsaUnitErrorDetail. - """ - # Field is not nullable - if reason is None: - raise ValueError("Invalid value for 'reason', must not be 'None'") - # Field is required - if reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'reason', must not be 'Unset'") - self._reason = reason - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_reason.py deleted file mode 100644 index 32bb1a2ff..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_error_reason.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitErrorReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - EMPTYSYMBOL = "emptySymbol" - DUPLICATESYMBOL = "duplicateSymbol" - SYMBOLCANNOTCONTAINCOMMA = "symbolCannotContainComma" - NAMEDENTITY = "namedEntity" - EQUATION = "equation" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_system.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_system.py index 0b0830e6f..87fe90947 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_system.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_system.py @@ -138,7 +138,6 @@ def unit_mappings(self, unit_mappings: "list[GsaUnitMapping]") -> None: @property def display_names(self) -> "dict[str, str]": """Gets the display_names of this GsaUnitSystem. - A dictionary of the culture name to the name that should be used in that culture for the item Returns ------- @@ -150,7 +149,6 @@ def display_names(self) -> "dict[str, str]": @display_names.setter def display_names(self, display_names: "dict[str, str]") -> None: """Sets the display_names of this GsaUnitSystem. - A dictionary of the culture name to the name that should be used in that culture for the item Parameters ---------- diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_systems_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_systems_info.py index 8f7807491..174bc91a5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_systems_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_systems_info.py @@ -61,7 +61,7 @@ class GsaUnitSystemsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "unit_systems": "list[GsaSlimLocalizedEntity]", + "unit_systems": "list[GsaSlimUnitSystem]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaUnitSystemsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "unitSystems": "GsaSlimLocalizedEntity", + "unitSystems": "GsaSlimUnitSystem", } discriminator: Optional[str] = None @@ -77,39 +77,37 @@ class GsaUnitSystemsInfo(ModelBase): def __init__( self, *, - unit_systems: "list[GsaSlimLocalizedEntity] | None | Unset_Type" = Unset, + unit_systems: "list[GsaSlimUnitSystem] | None | Unset_Type" = Unset, ) -> None: """GsaUnitSystemsInfo - a model defined in Swagger Parameters ---------- - unit_systems: list[GsaSlimLocalizedEntity] | None, optional + unit_systems: list[GsaSlimUnitSystem] | None, optional """ - self._unit_systems: list[GsaSlimLocalizedEntity] | None | Unset_Type = Unset + self._unit_systems: list[GsaSlimUnitSystem] | None | Unset_Type = Unset if unit_systems is not Unset: self.unit_systems = unit_systems @property - def unit_systems(self) -> "list[GsaSlimLocalizedEntity] | None | Unset_Type": + def unit_systems(self) -> "list[GsaSlimUnitSystem] | None | Unset_Type": """Gets the unit_systems of this GsaUnitSystemsInfo. Returns ------- - list[GsaSlimLocalizedEntity] | None | Unset_Type + list[GsaSlimUnitSystem] | None | Unset_Type The unit_systems of this GsaUnitSystemsInfo. """ return self._unit_systems @unit_systems.setter - def unit_systems( - self, unit_systems: "list[GsaSlimLocalizedEntity] | None | Unset_Type" - ) -> None: + def unit_systems(self, unit_systems: "list[GsaSlimUnitSystem] | None | Unset_Type") -> None: """Sets the unit_systems of this GsaUnitSystemsInfo. Parameters ---------- - unit_systems: list[GsaSlimLocalizedEntity] | None | Unset_Type + unit_systems: list[GsaSlimUnitSystem] | None | Unset_Type The unit_systems of this GsaUnitSystemsInfo. """ self._unit_systems = unit_systems diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_update_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_update_exception.py deleted file mode 100644 index 38ccbd68b..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_update_exception.py +++ /dev/null @@ -1,240 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitUpdateException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "code": "GsaErrorCode", - "errors": "list[GsaUnitErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "errors": "GsaUnitErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaUnitErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitUpdateException - a model defined in Swagger - - Parameters - ---------- - guid: str - code: GsaErrorCode, optional - errors: list[GsaUnitErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._guid: str - self._errors: list[GsaUnitErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.guid = guid - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUnitUpdateException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUnitUpdateException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUnitUpdateException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUnitUpdateException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUnitUpdateException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUnitUpdateException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUnitUpdateException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUnitUpdateException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUnitUpdateException. - - Returns - ------- - str - The guid of this GsaUnitUpdateException. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUnitUpdateException. - - Parameters - ---------- - guid: str - The guid of this GsaUnitUpdateException. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def errors(self) -> "list[GsaUnitErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUnitUpdateException. - - Returns - ------- - list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitUpdateException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUnitUpdateException. - - Parameters - ---------- - errors: list[GsaUnitErrorDetail] | None | Unset_Type - The errors of this GsaUnitUpdateException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitUpdateException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage.py index b309b9558..640d1b644 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage.py @@ -61,11 +61,11 @@ class GsaUnitUsage(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "attributes": "list[GsaSlimAttribute]", + "attributes": "list[GsaSlimNamedEntity]", "constants": "list[GsaSlimNamedEntity]", - "expressions": "list[GsaSlimExpression]", + "expressions": "list[GsaSlimNamedEntity]", "parameters": "list[GsaSlimNamedEntity]", - "units": "list[GsaUnit]", + "units": "list[GsaSlimUnit]", } attribute_map: dict[str, str] = { @@ -77,11 +77,11 @@ class GsaUnitUsage(ModelBase): } subtype_mapping: dict[str, str] = { - "attributes": "GsaSlimAttribute", + "attributes": "GsaSlimNamedEntity", "parameters": "GsaSlimNamedEntity", "constants": "GsaSlimNamedEntity", - "expressions": "GsaSlimExpression", - "units": "GsaUnit", + "expressions": "GsaSlimNamedEntity", + "units": "GsaSlimUnit", } discriminator: Optional[str] = None @@ -89,147 +89,172 @@ class GsaUnitUsage(ModelBase): def __init__( self, *, - attributes: "list[GsaSlimAttribute] | None | Unset_Type" = Unset, - constants: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - expressions: "list[GsaSlimExpression] | None | Unset_Type" = Unset, - parameters: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - units: "list[GsaUnit] | None | Unset_Type" = Unset, + attributes: "list[GsaSlimNamedEntity]", + constants: "list[GsaSlimNamedEntity]", + expressions: "list[GsaSlimNamedEntity]", + parameters: "list[GsaSlimNamedEntity]", + units: "list[GsaSlimUnit]", ) -> None: """GsaUnitUsage - a model defined in Swagger Parameters ---------- - attributes: list[GsaSlimAttribute] | None, optional - constants: list[GsaSlimNamedEntity] | None, optional - expressions: list[GsaSlimExpression] | None, optional - parameters: list[GsaSlimNamedEntity] | None, optional - units: list[GsaUnit] | None, optional + attributes: list[GsaSlimNamedEntity] + constants: list[GsaSlimNamedEntity] + expressions: list[GsaSlimNamedEntity] + parameters: list[GsaSlimNamedEntity] + units: list[GsaSlimUnit] """ - self._attributes: list[GsaSlimAttribute] | None | Unset_Type = Unset - self._parameters: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._constants: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - self._expressions: list[GsaSlimExpression] | None | Unset_Type = Unset - self._units: list[GsaUnit] | None | Unset_Type = Unset - - if attributes is not Unset: - self.attributes = attributes - if parameters is not Unset: - self.parameters = parameters - if constants is not Unset: - self.constants = constants - if expressions is not Unset: - self.expressions = expressions - if units is not Unset: - self.units = units + self._attributes: list[GsaSlimNamedEntity] + self._parameters: list[GsaSlimNamedEntity] + self._constants: list[GsaSlimNamedEntity] + self._expressions: list[GsaSlimNamedEntity] + self._units: list[GsaSlimUnit] + + self.attributes = attributes + self.parameters = parameters + self.constants = constants + self.expressions = expressions + self.units = units @property - def attributes(self) -> "list[GsaSlimAttribute] | None | Unset_Type": + def attributes(self) -> "list[GsaSlimNamedEntity]": """Gets the attributes of this GsaUnitUsage. Returns ------- - list[GsaSlimAttribute] | None | Unset_Type + list[GsaSlimNamedEntity] The attributes of this GsaUnitUsage. """ return self._attributes @attributes.setter - def attributes(self, attributes: "list[GsaSlimAttribute] | None | Unset_Type") -> None: + def attributes(self, attributes: "list[GsaSlimNamedEntity]") -> None: """Sets the attributes of this GsaUnitUsage. Parameters ---------- - attributes: list[GsaSlimAttribute] | None | Unset_Type + attributes: list[GsaSlimNamedEntity] The attributes of this GsaUnitUsage. """ + # Field is not nullable + if attributes is None: + raise ValueError("Invalid value for 'attributes', must not be 'None'") + # Field is required + if attributes is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'attributes', must not be 'Unset'") self._attributes = attributes @property - def parameters(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + def parameters(self) -> "list[GsaSlimNamedEntity]": """Gets the parameters of this GsaUnitUsage. Returns ------- - list[GsaSlimNamedEntity] | None | Unset_Type + list[GsaSlimNamedEntity] The parameters of this GsaUnitUsage. """ return self._parameters @parameters.setter - def parameters(self, parameters: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: + def parameters(self, parameters: "list[GsaSlimNamedEntity]") -> None: """Sets the parameters of this GsaUnitUsage. Parameters ---------- - parameters: list[GsaSlimNamedEntity] | None | Unset_Type + parameters: list[GsaSlimNamedEntity] The parameters of this GsaUnitUsage. """ + # Field is not nullable + if parameters is None: + raise ValueError("Invalid value for 'parameters', must not be 'None'") + # Field is required + if parameters is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'parameters', must not be 'Unset'") self._parameters = parameters @property - def constants(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": + def constants(self) -> "list[GsaSlimNamedEntity]": """Gets the constants of this GsaUnitUsage. Returns ------- - list[GsaSlimNamedEntity] | None | Unset_Type + list[GsaSlimNamedEntity] The constants of this GsaUnitUsage. """ return self._constants @constants.setter - def constants(self, constants: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: + def constants(self, constants: "list[GsaSlimNamedEntity]") -> None: """Sets the constants of this GsaUnitUsage. Parameters ---------- - constants: list[GsaSlimNamedEntity] | None | Unset_Type + constants: list[GsaSlimNamedEntity] The constants of this GsaUnitUsage. """ + # Field is not nullable + if constants is None: + raise ValueError("Invalid value for 'constants', must not be 'None'") + # Field is required + if constants is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'constants', must not be 'Unset'") self._constants = constants @property - def expressions(self) -> "list[GsaSlimExpression] | None | Unset_Type": + def expressions(self) -> "list[GsaSlimNamedEntity]": """Gets the expressions of this GsaUnitUsage. Returns ------- - list[GsaSlimExpression] | None | Unset_Type + list[GsaSlimNamedEntity] The expressions of this GsaUnitUsage. """ return self._expressions @expressions.setter - def expressions(self, expressions: "list[GsaSlimExpression] | None | Unset_Type") -> None: + def expressions(self, expressions: "list[GsaSlimNamedEntity]") -> None: """Sets the expressions of this GsaUnitUsage. Parameters ---------- - expressions: list[GsaSlimExpression] | None | Unset_Type + expressions: list[GsaSlimNamedEntity] The expressions of this GsaUnitUsage. """ + # Field is not nullable + if expressions is None: + raise ValueError("Invalid value for 'expressions', must not be 'None'") + # Field is required + if expressions is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'expressions', must not be 'Unset'") self._expressions = expressions @property - def units(self) -> "list[GsaUnit] | None | Unset_Type": + def units(self) -> "list[GsaSlimUnit]": """Gets the units of this GsaUnitUsage. Returns ------- - list[GsaUnit] | None | Unset_Type + list[GsaSlimUnit] The units of this GsaUnitUsage. """ return self._units @units.setter - def units(self, units: "list[GsaUnit] | None | Unset_Type") -> None: + def units(self, units: "list[GsaSlimUnit]") -> None: """Sets the units of this GsaUnitUsage. Parameters ---------- - units: list[GsaUnit] | None | Unset_Type + units: list[GsaSlimUnit] The units of this GsaUnitUsage. """ + # Field is not nullable + if units is None: + raise ValueError("Invalid value for 'units', must not be 'None'") + # Field is required + if units is Unset: # type: ignore[comparison-overlap, unused-ignore] + raise ValueError("Invalid value for 'units', must not be 'Unset'") self._units = units @classmethod diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_data_modification_error_detail.py deleted file mode 100644 index de43a4e2d..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_data_modification_error_detail.py +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_data_modification_error_reason import ( - GsaDataModificationErrorReason, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_referenced_by_type import ( - GsaReferencedByType, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_usage_data_modification_error_detail import ( # noqa: F401 - GsaUsageDataModificationErrorDetail, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitUsageDataModificationErrorDetail(GsaUsageDataModificationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaDataModificationErrorReason", - "referenced_by_type": "GsaReferencedByType", - "referenced_by": "list[GsaSlimNamedEntity]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "referenced_by_type": "referencedByType", - "referenced_by": "referencedBy", - } - - subtype_mapping: dict[str, str] = { - "referencedBy": "GsaSlimNamedEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaDataModificationErrorReason" = GsaDataModificationErrorReason.USAGE, - referenced_by_type: "GsaReferencedByType" = GsaReferencedByType.UNIT, - referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitUsageDataModificationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaDataModificationErrorReason - referenced_by_type: GsaReferencedByType - referenced_by: list[GsaSlimNamedEntity] | None, optional - """ - super().__init__(message=message, reason=reason, referenced_by_type=referenced_by_type) - self._referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type = Unset - - if referenced_by is not Unset: - self.referenced_by = referenced_by - - @property - def referenced_by(self) -> "list[GsaSlimNamedEntity] | None | Unset_Type": - """Gets the referenced_by of this GsaUnitUsageDataModificationErrorDetail. - - Returns - ------- - list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaUnitUsageDataModificationErrorDetail. - """ - return self._referenced_by - - @referenced_by.setter - def referenced_by(self, referenced_by: "list[GsaSlimNamedEntity] | None | Unset_Type") -> None: - """Sets the referenced_by of this GsaUnitUsageDataModificationErrorDetail. - - Parameters - ---------- - referenced_by: list[GsaSlimNamedEntity] | None | Unset_Type - The referenced_by of this GsaUnitUsageDataModificationErrorDetail. - """ - self._referenced_by = referenced_by - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitUsageDataModificationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_type.py deleted file mode 100644 index ee1bd3e5a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unit_usage_type.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUnitUsageType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - ATTRIBUTES = "attributes" - PARAMETERS = "parameters" - CONSTANTS = "constants" - EXPRESSIONS = "expressions" - UNITS = "units" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_grouping_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_grouping_info.py deleted file mode 100644 index 7c4ee1a30..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_grouping_info.py +++ /dev/null @@ -1,142 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnitsGroupingInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "unit_groups": "list[list[GsaSlimUnit]]", - } - - attribute_map: dict[str, str] = { - "unit_groups": "unitGroups", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - unit_groups: "list[list[GsaSlimUnit]] | None | Unset_Type" = Unset, - ) -> None: - """GsaUnitsGroupingInfo - a model defined in Swagger - - Parameters - ---------- - unit_groups: list[list[GsaSlimUnit]] | None, optional - """ - self._unit_groups: list[list[GsaSlimUnit]] | None | Unset_Type = Unset - - if unit_groups is not Unset: - self.unit_groups = unit_groups - - @property - def unit_groups(self) -> "list[list[GsaSlimUnit]] | None | Unset_Type": - """Gets the unit_groups of this GsaUnitsGroupingInfo. - - Returns - ------- - list[list[GsaSlimUnit]] | None | Unset_Type - The unit_groups of this GsaUnitsGroupingInfo. - """ - return self._unit_groups - - @unit_groups.setter - def unit_groups(self, unit_groups: "list[list[GsaSlimUnit]] | None | Unset_Type") -> None: - """Sets the unit_groups of this GsaUnitsGroupingInfo. - - Parameters - ---------- - unit_groups: list[list[GsaSlimUnit]] | None | Unset_Type - The unit_groups of this GsaUnitsGroupingInfo. - """ - self._unit_groups = unit_groups - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnitsGroupingInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_info.py index a1359309d..b00c54ae0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_info.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_units_info.py @@ -61,7 +61,7 @@ class GsaUnitsInfo(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "units": "list[GsaUnit]", + "units": "list[GsaSlimNamedUnit]", } attribute_map: dict[str, str] = { @@ -69,7 +69,7 @@ class GsaUnitsInfo(ModelBase): } subtype_mapping: dict[str, str] = { - "units": "GsaUnit", + "units": "GsaSlimNamedUnit", } discriminator: Optional[str] = None @@ -77,37 +77,37 @@ class GsaUnitsInfo(ModelBase): def __init__( self, *, - units: "list[GsaUnit] | None | Unset_Type" = Unset, + units: "list[GsaSlimNamedUnit] | None | Unset_Type" = Unset, ) -> None: """GsaUnitsInfo - a model defined in Swagger Parameters ---------- - units: list[GsaUnit] | None, optional + units: list[GsaSlimNamedUnit] | None, optional """ - self._units: list[GsaUnit] | None | Unset_Type = Unset + self._units: list[GsaSlimNamedUnit] | None | Unset_Type = Unset if units is not Unset: self.units = units @property - def units(self) -> "list[GsaUnit] | None | Unset_Type": + def units(self) -> "list[GsaSlimNamedUnit] | None | Unset_Type": """Gets the units of this GsaUnitsInfo. Returns ------- - list[GsaUnit] | None | Unset_Type + list[GsaSlimNamedUnit] | None | Unset_Type The units of this GsaUnitsInfo. """ return self._units @units.setter - def units(self, units: "list[GsaUnit] | None | Unset_Type") -> None: + def units(self, units: "list[GsaSlimNamedUnit] | None | Unset_Type") -> None: """Sets the units of this GsaUnitsInfo. Parameters ---------- - units: list[GsaUnit] | None | Unset_Type + units: list[GsaSlimNamedUnit] | None | Unset_Type The units of this GsaUnitsInfo. """ self._units = units diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py deleted file mode 100644 index 0f382f320..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unknown_unit_symbol_unit_equation_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_detail import ( # noqa: F401 - GsaUnitEquationErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_unit_equation_error_reason import ( - GsaUnitEquationErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnknownUnitSymbolUnitEquationErrorDetail(GsaUnitEquationErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaUnitEquationErrorReason", - "symbol": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "symbol": "symbol", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaUnitEquationErrorReason" = GsaUnitEquationErrorReason.UNKNOWNUNITSYMBOL, - symbol: "str", - ) -> None: - """GsaUnknownUnitSymbolUnitEquationErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaUnitEquationErrorReason - symbol: str - """ - super().__init__(message=message, reason=reason) - self._symbol: str - - self.symbol = symbol - - @property - def symbol(self) -> "str": - """Gets the symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - - Returns - ------- - str - The symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - """ - return self._symbol - - @symbol.setter - def symbol(self, symbol: "str") -> None: - """Sets the symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - - Parameters - ---------- - symbol: str - The symbol of this GsaUnknownUnitSymbolUnitEquationErrorDetail. - """ - # Field is not nullable - if symbol is None: - raise ValueError("Invalid value for 'symbol', must not be 'None'") - # Field is required - if symbol is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'symbol', must not be 'Unset'") - self._symbol = symbol - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnknownUnitSymbolUnitEquationErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_attribute_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_attribute_guids_error_detail.py deleted file mode 100644 index 974b0358a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_attribute_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedAttributeGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDATTRIBUTEGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedAttributeGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedAttributeGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedAttributeGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py deleted file mode 100644 index 2aebf42fb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_cross_database_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDCROSSDATABASERECORDLINKGROUPGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_parameter_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_parameter_guids_error_detail.py deleted file mode 100644 index b198d452a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_parameter_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedParameterGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDPARAMETERGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedParameterGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedParameterGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedParameterGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_record_link_group_guids_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_record_link_group_guids_error_detail.py deleted file mode 100644 index 2ab61af4e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_record_link_group_guids_error_detail.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_detail import ( # noqa: F401 - GsaStandardNameErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_standard_name_error_reason import ( - GsaStandardNameErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedRecordLinkGroupGuidsErrorDetail(GsaStandardNameErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaStandardNameErrorReason", - "unresolved_guids": "list[str]", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "unresolved_guids": "unresolvedGuids", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaStandardNameErrorReason" = GsaStandardNameErrorReason.UNRESOLVEDRECORDLINKGROUPGUIDS, - unresolved_guids: "list[str]", - ) -> None: - """GsaUnresolvedRecordLinkGroupGuidsErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaStandardNameErrorReason - unresolved_guids: list[str] - """ - super().__init__(message=message, reason=reason) - self._unresolved_guids: list[str] - - self.unresolved_guids = unresolved_guids - - @property - def unresolved_guids(self) -> "list[str]": - """Gets the unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - - Returns - ------- - list[str] - The unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - """ - return self._unresolved_guids - - @unresolved_guids.setter - def unresolved_guids(self, unresolved_guids: "list[str]") -> None: - """Sets the unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - - Parameters - ---------- - unresolved_guids: list[str] - The unresolved_guids of this GsaUnresolvedRecordLinkGroupGuidsErrorDetail. - """ - # Field is not nullable - if unresolved_guids is None: - raise ValueError("Invalid value for 'unresolved_guids', must not be 'None'") - # Field is required - if unresolved_guids is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'unresolved_guids', must not be 'Unset'") - self._unresolved_guids = unresolved_guids - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedRecordLinkGroupGuidsErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_target_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_target_attribute.py deleted file mode 100644 index 85353eddc..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_unresolved_target_attribute.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_target_attribute import ( # noqa: F401 - GsaTargetAttribute, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_target_attribute_type import ( - GsaTargetAttributeType, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUnresolvedTargetAttribute(GsaTargetAttribute): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "target_type": "GsaTargetAttributeType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "target_type": "targetType", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - target_type: "GsaTargetAttributeType" = GsaTargetAttributeType.UNRESOLVED, - ) -> None: - """GsaUnresolvedTargetAttribute - a model defined in Swagger - - Parameters - ---------- - guid: str - target_type: GsaTargetAttributeType - """ - super().__init__(guid=guid, target_type=target_type) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUnresolvedTargetAttribute): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control.py deleted file mode 100644 index 7ed5886db..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator_class_map: dict[str, str] - They key is discriminator value and the value is associated subtype. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - discriminator_value_class_map = { - "permissionBased".lower(): "#/components/schemas/GsaUpdatePermissionBasedAccessControl", - "attributeBased".lower(): "#/components/schemas/GsaUpdateAttributeBasedAccessControl", - } - - discriminator: Optional[str] = "mode" - - def __init__( - self, - *, - mode: "GsaAccessControlMode", - ) -> None: - """GsaUpdateAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - self._mode: GsaAccessControlMode - - self.mode = mode - - @property - def mode(self) -> "GsaAccessControlMode": - """Gets the mode of this GsaUpdateAccessControl. - - Returns - ------- - GsaAccessControlMode - The mode of this GsaUpdateAccessControl. - """ - return self._mode - - @mode.setter - def mode(self, mode: "GsaAccessControlMode") -> None: - """Sets the mode of this GsaUpdateAccessControl. - - Parameters - ---------- - mode: GsaAccessControlMode - The mode of this GsaUpdateAccessControl. - """ - # Field is not nullable - if mode is None: - raise ValueError("Invalid value for 'mode', must not be 'None'") - # Field is required - if mode is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'mode', must not be 'Unset'") - self._mode = mode - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Returns the real base class as determined by the discriminator - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - """ - discriminator_value = str(data[cls._get_discriminator_field_name()]).lower() - # The actual class name is not available in swagger-codegen, - # so we have to extract it from the JSON reference - return cls.discriminator_value_class_map[discriminator_value].rsplit("/", 1)[-1] - - @classmethod - def _get_discriminator_field_name(cls) -> str: - assert cls.discriminator - name_tokens = cls.discriminator.split("_") - later_tokens = [element.capitalize() for element in name_tokens[1:]] - return "".join([name_tokens[0], *later_tokens]) - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category.py deleted file mode 100644 index 7db4b845a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControlCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "table_mappings": "list[GsaUpdateAccessControlCategoryTableMapping]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "table_mappings": "tableMappings", - } - - subtype_mapping: dict[str, str] = { - "tableMappings": "GsaUpdateAccessControlCategoryTableMapping", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - table_mappings: "list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type" = Unset, - ) -> None: - """GsaUpdateAccessControlCategory - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - table_mappings: list[GsaUpdateAccessControlCategoryTableMapping], optional - """ - self._table_mappings: list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if table_mappings is not Unset: - self.table_mappings = table_mappings - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def table_mappings(self) -> "list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type": - """Gets the table_mappings of this GsaUpdateAccessControlCategory. - - Returns - ------- - list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type - The table_mappings of this GsaUpdateAccessControlCategory. - """ - return self._table_mappings - - @table_mappings.setter - def table_mappings( - self, table_mappings: "list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type" - ) -> None: - """Sets the table_mappings of this GsaUpdateAccessControlCategory. - - Parameters - ---------- - table_mappings: list[GsaUpdateAccessControlCategoryTableMapping] | Unset_Type - The table_mappings of this GsaUpdateAccessControlCategory. - """ - # Field is not nullable - if table_mappings is None: - raise ValueError("Invalid value for 'table_mappings', must not be 'None'") - self._table_mappings = table_mappings - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdateAccessControlCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdateAccessControlCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdateAccessControlCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdateAccessControlCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdateAccessControlCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdateAccessControlCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdateAccessControlCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControlCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category_table_mapping.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category_table_mapping.py deleted file mode 100644 index 89968cfb2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_access_control_category_table_mapping.py +++ /dev/null @@ -1,214 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAccessControlCategoryTableMapping(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "table_discrete_values": "list[GsaSlimEntity]", - } - - attribute_map: dict[str, str] = { - "table": "table", - "attribute": "attribute", - "table_discrete_values": "tableDiscreteValues", - } - - subtype_mapping: dict[str, str] = { - "table": "GsaSlimEntity", - "attribute": "GsaSlimEntity", - "tableDiscreteValues": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - table: "GsaSlimEntity", - attribute: "GsaSlimEntity | Unset_Type" = Unset, - table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateAccessControlCategoryTableMapping - a model defined in Swagger - - Parameters - ---------- - table: GsaSlimEntity - attribute: GsaSlimEntity, optional - table_discrete_values: list[GsaSlimEntity] | None, optional - """ - self._table: GsaSlimEntity - self._attribute: GsaSlimEntity | Unset_Type = Unset - self._table_discrete_values: list[GsaSlimEntity] | None | Unset_Type = Unset - - self.table = table - if attribute is not Unset: - self.attribute = attribute - if table_discrete_values is not Unset: - self.table_discrete_values = table_discrete_values - - @property - def table(self) -> "GsaSlimEntity": - """Gets the table of this GsaUpdateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity - The table of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._table - - @table.setter - def table(self, table: "GsaSlimEntity") -> None: - """Sets the table of this GsaUpdateAccessControlCategoryTableMapping. - - Parameters - ---------- - table: GsaSlimEntity - The table of this GsaUpdateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if table is None: - raise ValueError("Invalid value for 'table', must not be 'None'") - # Field is required - if table is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'table', must not be 'Unset'") - self._table = table - - @property - def attribute(self) -> "GsaSlimEntity | Unset_Type": - """Gets the attribute of this GsaUpdateAccessControlCategoryTableMapping. - - Returns - ------- - GsaSlimEntity | Unset_Type - The attribute of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._attribute - - @attribute.setter - def attribute(self, attribute: "GsaSlimEntity | Unset_Type") -> None: - """Sets the attribute of this GsaUpdateAccessControlCategoryTableMapping. - - Parameters - ---------- - attribute: GsaSlimEntity | Unset_Type - The attribute of this GsaUpdateAccessControlCategoryTableMapping. - """ - # Field is not nullable - if attribute is None: - raise ValueError("Invalid value for 'attribute', must not be 'None'") - self._attribute = attribute - - @property - def table_discrete_values(self) -> "list[GsaSlimEntity] | None | Unset_Type": - """Gets the table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - - Returns - ------- - list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - """ - return self._table_discrete_values - - @table_discrete_values.setter - def table_discrete_values( - self, table_discrete_values: "list[GsaSlimEntity] | None | Unset_Type" - ) -> None: - """Sets the table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - - Parameters - ---------- - table_discrete_values: list[GsaSlimEntity] | None | Unset_Type - The table_discrete_values of this GsaUpdateAccessControlCategoryTableMapping. - """ - self._table_discrete_values = table_discrete_values - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAccessControlCategoryTableMapping): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute.py index c9f5231bc..a31604e38 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute.py @@ -67,7 +67,6 @@ class GsaUpdateAttribute(ModelBase): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -79,7 +78,6 @@ class GsaUpdateAttribute(ModelBase): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -120,7 +118,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -134,7 +131,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -146,7 +142,6 @@ def __init__( self._help_path: str | None | Unset_Type = Unset self._about_attribute: GsaSlimEntity | Unset_Type = Unset self._is_hidden_from_search_criteria: bool | None | Unset_Type = Unset - self._display_names: dict[str, str] | None | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset @@ -161,8 +156,6 @@ def __init__( self.about_attribute = about_attribute if is_hidden_from_search_criteria is not Unset: self.is_hidden_from_search_criteria = is_hidden_from_search_criteria - if display_names is not Unset: - self.display_names = display_names if name is not Unset: self.name = name if guid is not Unset: @@ -321,30 +314,6 @@ def is_hidden_from_search_criteria( """ self._is_hidden_from_search_criteria = is_hidden_from_search_criteria - @property - def display_names(self) -> "dict[str, str] | None | Unset_Type": - """Gets the display_names of this GsaUpdateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Returns - ------- - dict[str, str] | None | Unset_Type - The display_names of this GsaUpdateAttribute. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str] | None | Unset_Type") -> None: - """Sets the display_names of this GsaUpdateAttribute. - Set a display name for different languages. Supported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\". - - Parameters - ---------- - display_names: dict[str, str] | None | Unset_Type - The display_names of this GsaUpdateAttribute. - """ - self._display_names = display_names - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateAttribute. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute_based_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute_based_access_control.py deleted file mode 100644 index 26c618df5..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_attribute_based_access_control.py +++ /dev/null @@ -1,163 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_update_access_control import ( # noqa: F401 - GsaUpdateAccessControl, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateAttributeBasedAccessControl(GsaUpdateAccessControl): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - "update_current_rule_engine": "GsaUpdateCurrentRuleEngine", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - "update_current_rule_engine": "updateCurrentRuleEngine", - } - - subtype_mapping: dict[str, str] = { - "updateCurrentRuleEngine": "GsaUpdateCurrentRuleEngine", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.ATTRIBUTEBASED, - update_current_rule_engine: "GsaUpdateCurrentRuleEngine", - ) -> None: - """GsaUpdateAttributeBasedAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - update_current_rule_engine: GsaUpdateCurrentRuleEngine - """ - super().__init__(mode=mode) - self._update_current_rule_engine: GsaUpdateCurrentRuleEngine - - self.update_current_rule_engine = update_current_rule_engine - - @property - def update_current_rule_engine(self) -> "GsaUpdateCurrentRuleEngine": - """Gets the update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - - Returns - ------- - GsaUpdateCurrentRuleEngine - The update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - """ - return self._update_current_rule_engine - - @update_current_rule_engine.setter - def update_current_rule_engine( - self, update_current_rule_engine: "GsaUpdateCurrentRuleEngine" - ) -> None: - """Sets the update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - - Parameters - ---------- - update_current_rule_engine: GsaUpdateCurrentRuleEngine - The update_current_rule_engine of this GsaUpdateAttributeBasedAccessControl. - """ - # Field is not nullable - if update_current_rule_engine is None: - raise ValueError("Invalid value for 'update_current_rule_engine', must not be 'None'") - # Field is required - if update_current_rule_engine is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'update_current_rule_engine', must not be 'Unset'") - self._update_current_rule_engine = update_current_rule_engine - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateAttributeBasedAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_current_rule_engine.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_current_rule_engine.py deleted file mode 100644 index d6e88a38e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_current_rule_engine.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateCurrentRuleEngine(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "fully_qualified_type_name": "str", - } - - attribute_map: dict[str, str] = { - "fully_qualified_type_name": "fullyQualifiedTypeName", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - fully_qualified_type_name: "str", - ) -> None: - """GsaUpdateCurrentRuleEngine - a model defined in Swagger - - Parameters - ---------- - fully_qualified_type_name: str - """ - self._fully_qualified_type_name: str - - self.fully_qualified_type_name = fully_qualified_type_name - - @property - def fully_qualified_type_name(self) -> "str": - """Gets the fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - The fully qualified name of the rule engine implementation. - - Returns - ------- - str - The fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - """ - return self._fully_qualified_type_name - - @fully_qualified_type_name.setter - def fully_qualified_type_name(self, fully_qualified_type_name: "str") -> None: - """Sets the fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - The fully qualified name of the rule engine implementation. - - Parameters - ---------- - fully_qualified_type_name: str - The fully_qualified_type_name of this GsaUpdateCurrentRuleEngine. - """ - # Field is not nullable - if fully_qualified_type_name is None: - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'None'") - # Field is required - if fully_qualified_type_name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'fully_qualified_type_name', must not be 'Unset'") - self._fully_qualified_type_name = fully_qualified_type_name - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateCurrentRuleEngine): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database.py index 512fdf21c..b40fb090b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database.py @@ -67,10 +67,8 @@ class GsaUpdateDatabase(ModelBase): "currency_code": "str", "data_source": "str", "database_key": "str", - "default_table": "GsaSlimEntity", "guid": "str", "initial_catalog": "str", - "is_implicit_profile_disabled": "bool", "is_read_only": "bool", "language": "str", "loading_order": "int", @@ -78,7 +76,6 @@ class GsaUpdateDatabase(ModelBase): "notes": "str", "sql_password": "str", "sql_user_name": "str", - "use_configuration_database_credentials": "bool", "use_integrated_security": "bool", "version_guid": "str", } @@ -90,10 +87,8 @@ class GsaUpdateDatabase(ModelBase): "currency_code": "currencyCode", "data_source": "dataSource", "database_key": "databaseKey", - "default_table": "defaultTable", "guid": "guid", "initial_catalog": "initialCatalog", - "is_implicit_profile_disabled": "isImplicitProfileDisabled", "is_read_only": "isReadOnly", "language": "language", "loading_order": "loadingOrder", @@ -101,14 +96,11 @@ class GsaUpdateDatabase(ModelBase): "notes": "notes", "sql_password": "sqlPassword", "sql_user_name": "sqlUserName", - "use_configuration_database_credentials": "useConfigurationDatabaseCredentials", "use_integrated_security": "useIntegratedSecurity", "version_guid": "versionGuid", } - subtype_mapping: dict[str, str] = { - "defaultTable": "GsaSlimEntity", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -121,10 +113,8 @@ def __init__( currency_code: "str | None | Unset_Type" = Unset, data_source: "str | None | Unset_Type" = Unset, database_key: "str | None | Unset_Type" = Unset, - default_table: "GsaSlimEntity | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, initial_catalog: "str | None | Unset_Type" = Unset, - is_implicit_profile_disabled: "bool | Unset_Type" = Unset, is_read_only: "bool | Unset_Type" = Unset, language: "str | None | Unset_Type" = Unset, loading_order: "int | Unset_Type" = Unset, @@ -132,7 +122,6 @@ def __init__( notes: "str | None | Unset_Type" = Unset, sql_password: "str | None | Unset_Type" = Unset, sql_user_name: "str | None | Unset_Type" = Unset, - use_configuration_database_credentials: "bool | None | Unset_Type" = Unset, use_integrated_security: "bool | None | Unset_Type" = Unset, version_guid: "str | Unset_Type" = Unset, ) -> None: @@ -146,10 +135,8 @@ def __init__( currency_code: str | None, optional data_source: str | None, optional database_key: str | None, optional - default_table: GsaSlimEntity, optional guid: str, optional initial_catalog: str | None, optional - is_implicit_profile_disabled: bool, optional is_read_only: bool, optional language: str | None, optional loading_order: int, optional @@ -157,7 +144,6 @@ def __init__( notes: str | None, optional sql_password: str | None, optional sql_user_name: str | None, optional - use_configuration_database_credentials: bool | None, optional use_integrated_security: bool | None, optional version_guid: str, optional """ @@ -168,19 +154,16 @@ def __init__( self._version_guid: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset self._name: str | Unset_Type = Unset - self._is_implicit_profile_disabled: bool | Unset_Type = Unset self._is_read_only: bool | Unset_Type = Unset self._language: str | None | Unset_Type = Unset self._database_key: str | None | Unset_Type = Unset self._data_source: str | None | Unset_Type = Unset - self._use_configuration_database_credentials: bool | None | Unset_Type = Unset self._use_integrated_security: bool | None | Unset_Type = Unset self._sql_user_name: str | None | Unset_Type = Unset self._sql_password: str | None | Unset_Type = Unset self._initial_catalog: str | None | Unset_Type = Unset self._additional_sql_parameters: str | None | Unset_Type = Unset self._loading_order: int | Unset_Type = Unset - self._default_table: GsaSlimEntity | Unset_Type = Unset if author is not Unset: self.author = author @@ -196,8 +179,6 @@ def __init__( self.guid = guid if name is not Unset: self.name = name - if is_implicit_profile_disabled is not Unset: - self.is_implicit_profile_disabled = is_implicit_profile_disabled if is_read_only is not Unset: self.is_read_only = is_read_only if language is not Unset: @@ -206,8 +187,6 @@ def __init__( self.database_key = database_key if data_source is not Unset: self.data_source = data_source - if use_configuration_database_credentials is not Unset: - self.use_configuration_database_credentials = use_configuration_database_credentials if use_integrated_security is not Unset: self.use_integrated_security = use_integrated_security if sql_user_name is not Unset: @@ -220,8 +199,6 @@ def __init__( self.additional_sql_parameters = additional_sql_parameters if loading_order is not Unset: self.loading_order = loading_order - if default_table is not Unset: - self.default_table = default_table @property def author(self) -> "str | None | Unset_Type": @@ -400,35 +377,6 @@ def name(self, name: "str | Unset_Type") -> None: raise ValueError("Invalid value for 'name', must not be 'None'") self._name = name - @property - def is_implicit_profile_disabled(self) -> "bool | Unset_Type": - """Gets the is_implicit_profile_disabled of this GsaUpdateDatabase. - Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator - - Returns - ------- - bool | Unset_Type - The is_implicit_profile_disabled of this GsaUpdateDatabase. - """ - return self._is_implicit_profile_disabled - - @is_implicit_profile_disabled.setter - def is_implicit_profile_disabled( - self, is_implicit_profile_disabled: "bool | Unset_Type" - ) -> None: - """Sets the is_implicit_profile_disabled of this GsaUpdateDatabase. - Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator - - Parameters - ---------- - is_implicit_profile_disabled: bool | Unset_Type - The is_implicit_profile_disabled of this GsaUpdateDatabase. - """ - # Field is not nullable - if is_implicit_profile_disabled is None: - raise ValueError("Invalid value for 'is_implicit_profile_disabled', must not be 'None'") - self._is_implicit_profile_disabled = is_implicit_profile_disabled - @property def is_read_only(self) -> "bool | Unset_Type": """Gets the is_read_only of this GsaUpdateDatabase. @@ -528,32 +476,6 @@ def data_source(self, data_source: "str | None | Unset_Type") -> None: """ self._data_source = data_source - @property - def use_configuration_database_credentials(self) -> "bool | None | Unset_Type": - """Gets the use_configuration_database_credentials of this GsaUpdateDatabase. - Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator - - Returns - ------- - bool | None | Unset_Type - The use_configuration_database_credentials of this GsaUpdateDatabase. - """ - return self._use_configuration_database_credentials - - @use_configuration_database_credentials.setter - def use_configuration_database_credentials( - self, use_configuration_database_credentials: "bool | None | Unset_Type" - ) -> None: - """Sets the use_configuration_database_credentials of this GsaUpdateDatabase. - Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator - - Parameters - ---------- - use_configuration_database_credentials: bool | None | Unset_Type - The use_configuration_database_credentials of this GsaUpdateDatabase. - """ - self._use_configuration_database_credentials = use_configuration_database_credentials - @property def use_integrated_security(self) -> "bool | None | Unset_Type": """Gets the use_integrated_security of this GsaUpdateDatabase. @@ -703,31 +625,6 @@ def loading_order(self, loading_order: "int | Unset_Type") -> None: raise ValueError("Invalid value for 'loading_order', must not be 'None'") self._loading_order = loading_order - @property - def default_table(self) -> "GsaSlimEntity | Unset_Type": - """Gets the default_table of this GsaUpdateDatabase. - - Returns - ------- - GsaSlimEntity | Unset_Type - The default_table of this GsaUpdateDatabase. - """ - return self._default_table - - @default_table.setter - def default_table(self, default_table: "GsaSlimEntity | Unset_Type") -> None: - """Sets the default_table of this GsaUpdateDatabase. - - Parameters - ---------- - default_table: GsaSlimEntity | Unset_Type - The default_table of this GsaUpdateDatabase. - """ - # Field is not nullable - if default_table is None: - raise ValueError("Invalid value for 'default_table', must not be 'None'") - self._default_table = default_table - @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: """Raises a NotImplementedError for a type without a discriminator defined. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database_security_groups.py deleted file mode 100644 index 285ac6937..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_database_security_groups.py +++ /dev/null @@ -1,258 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDatabaseSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | None | Unset_Type" = Unset, - grant_group: "str | None | Unset_Type" = Unset, - power_user_group: "str | None | Unset_Type" = Unset, - read_group: "str | None | Unset_Type" = Unset, - write_group: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDatabaseSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str | None, optional - grant_group: str | None, optional - power_user_group: str | None, optional - read_group: str | None, optional - write_group: str | None, optional - """ - self._admin_group: str | None | Unset_Type = Unset - self._grant_group: str | None | Unset_Type = Unset - self._power_user_group: str | None | Unset_Type = Unset - self._write_group: str | None | Unset_Type = Unset - self._read_group: str | None | Unset_Type = Unset - - if admin_group is not Unset: - self.admin_group = admin_group - if grant_group is not Unset: - self.grant_group = grant_group - if power_user_group is not Unset: - self.power_user_group = power_user_group - if write_group is not Unset: - self.write_group = write_group - if read_group is not Unset: - self.read_group = read_group - - @property - def admin_group(self) -> "str | None | Unset_Type": - """Gets the admin_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The admin_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | None | Unset_Type") -> None: - """Sets the admin_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - admin_group: str | None | Unset_Type - The admin_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | None | Unset_Type": - """Gets the grant_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The grant_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | None | Unset_Type") -> None: - """Sets the grant_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - grant_group: str | None | Unset_Type - The grant_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | None | Unset_Type": - """Gets the power_user_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The power_user_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | None | Unset_Type") -> None: - """Sets the power_user_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - power_user_group: str | None | Unset_Type - The power_user_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | None | Unset_Type": - """Gets the write_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The write_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | None | Unset_Type") -> None: - """Sets the write_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - write_group: str | None | Unset_Type - The write_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._write_group = write_group - - @property - def read_group(self) -> "str | None | Unset_Type": - """Gets the read_group of this GsaUpdateDatabaseSecurityGroups. - - Returns - ------- - str | None | Unset_Type - The read_group of this GsaUpdateDatabaseSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | None | Unset_Type") -> None: - """Sets the read_group of this GsaUpdateDatabaseSecurityGroups. - - Parameters - ---------- - read_group: str | None | Unset_Type - The read_group of this GsaUpdateDatabaseSecurityGroups. - """ - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDatabaseSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_date_time_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_date_time_attribute.py index 9c80320ad..7ee05e99d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_date_time_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_date_time_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateDateTimeAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdateDateTimeAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_database.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_database.py deleted file mode 100644 index 672c31118..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_database.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDefaultDatabase(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "default_database_key": "str", - } - - attribute_map: dict[str, str] = { - "default_database_key": "defaultDatabaseKey", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - default_database_key: "str", - ) -> None: - """GsaUpdateDefaultDatabase - a model defined in Swagger - - Parameters - ---------- - default_database_key: str - """ - self._default_database_key: str - - self.default_database_key = default_database_key - - @property - def default_database_key(self) -> "str": - """Gets the default_database_key of this GsaUpdateDefaultDatabase. - - Returns - ------- - str - The default_database_key of this GsaUpdateDefaultDatabase. - """ - return self._default_database_key - - @default_database_key.setter - def default_database_key(self, default_database_key: "str") -> None: - """Sets the default_database_key of this GsaUpdateDefaultDatabase. - - Parameters - ---------- - default_database_key: str - The default_database_key of this GsaUpdateDefaultDatabase. - """ - # Field is not nullable - if default_database_key is None: - raise ValueError("Invalid value for 'default_database_key', must not be 'None'") - # Field is required - if default_database_key is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'default_database_key', must not be 'Unset'") - self._default_database_key = default_database_key - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDefaultDatabase): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_fallback_security_groups.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_fallback_security_groups.py deleted file mode 100644 index ade64e91a..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_default_fallback_security_groups.py +++ /dev/null @@ -1,305 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDefaultFallbackSecurityGroups(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "admin_group": "str", - "grant_group": "str", - "power_user_group": "str", - "read_group": "str", - "system_group": "str", - "write_group": "str", - } - - attribute_map: dict[str, str] = { - "admin_group": "adminGroup", - "grant_group": "grantGroup", - "power_user_group": "powerUserGroup", - "read_group": "readGroup", - "system_group": "systemGroup", - "write_group": "writeGroup", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - admin_group: "str | Unset_Type" = Unset, - grant_group: "str | Unset_Type" = Unset, - power_user_group: "str | Unset_Type" = Unset, - read_group: "str | Unset_Type" = Unset, - system_group: "str | Unset_Type" = Unset, - write_group: "str | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDefaultFallbackSecurityGroups - a model defined in Swagger - - Parameters - ---------- - admin_group: str, optional - grant_group: str, optional - power_user_group: str, optional - read_group: str, optional - system_group: str, optional - write_group: str, optional - """ - self._system_group: str | Unset_Type = Unset - self._admin_group: str | Unset_Type = Unset - self._grant_group: str | Unset_Type = Unset - self._power_user_group: str | Unset_Type = Unset - self._write_group: str | Unset_Type = Unset - self._read_group: str | Unset_Type = Unset - - if system_group is not Unset: - self.system_group = system_group - if admin_group is not Unset: - self.admin_group = admin_group - if grant_group is not Unset: - self.grant_group = grant_group - if power_user_group is not Unset: - self.power_user_group = power_user_group - if write_group is not Unset: - self.write_group = write_group - if read_group is not Unset: - self.read_group = read_group - - @property - def system_group(self) -> "str | Unset_Type": - """Gets the system_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The system_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._system_group - - @system_group.setter - def system_group(self, system_group: "str | Unset_Type") -> None: - """Sets the system_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - system_group: str | Unset_Type - The system_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if system_group is None: - raise ValueError("Invalid value for 'system_group', must not be 'None'") - self._system_group = system_group - - @property - def admin_group(self) -> "str | Unset_Type": - """Gets the admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._admin_group - - @admin_group.setter - def admin_group(self, admin_group: "str | Unset_Type") -> None: - """Sets the admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - admin_group: str | Unset_Type - The admin_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if admin_group is None: - raise ValueError("Invalid value for 'admin_group', must not be 'None'") - self._admin_group = admin_group - - @property - def grant_group(self) -> "str | Unset_Type": - """Gets the grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._grant_group - - @grant_group.setter - def grant_group(self, grant_group: "str | Unset_Type") -> None: - """Sets the grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - grant_group: str | Unset_Type - The grant_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if grant_group is None: - raise ValueError("Invalid value for 'grant_group', must not be 'None'") - self._grant_group = grant_group - - @property - def power_user_group(self) -> "str | Unset_Type": - """Gets the power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._power_user_group - - @power_user_group.setter - def power_user_group(self, power_user_group: "str | Unset_Type") -> None: - """Sets the power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - power_user_group: str | Unset_Type - The power_user_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if power_user_group is None: - raise ValueError("Invalid value for 'power_user_group', must not be 'None'") - self._power_user_group = power_user_group - - @property - def write_group(self) -> "str | Unset_Type": - """Gets the write_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The write_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._write_group - - @write_group.setter - def write_group(self, write_group: "str | Unset_Type") -> None: - """Sets the write_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - write_group: str | Unset_Type - The write_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if write_group is None: - raise ValueError("Invalid value for 'write_group', must not be 'None'") - self._write_group = write_group - - @property - def read_group(self) -> "str | Unset_Type": - """Gets the read_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Returns - ------- - str | Unset_Type - The read_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - return self._read_group - - @read_group.setter - def read_group(self, read_group: "str | Unset_Type") -> None: - """Sets the read_group of this GsaUpdateDefaultFallbackSecurityGroups. - - Parameters - ---------- - read_group: str | Unset_Type - The read_group of this GsaUpdateDefaultFallbackSecurityGroups. - """ - # Field is not nullable - if read_group is None: - raise ValueError("Invalid value for 'read_group', must not be 'None'") - self._read_group = read_group - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDefaultFallbackSecurityGroups): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_attribute.py index fa2e0cde5..7d7085bd8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateDiscreteAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -83,7 +82,6 @@ class GsaUpdateDiscreteAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -102,7 +100,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -117,7 +114,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -129,7 +125,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_functional_attribute.py index 0b0f3f319..36cfdfafd 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_functional_attribute.py @@ -71,7 +71,6 @@ class GsaUpdateDiscreteFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "list[GsaUpdateDiscreteFunctionalAttributeParameter]", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -84,7 +83,6 @@ class GsaUpdateDiscreteFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -105,7 +103,6 @@ def __init__( attribute_parameters: "list[GsaUpdateDiscreteFunctionalAttributeParameter] | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -120,7 +117,6 @@ def __init__( attribute_parameters: list[GsaUpdateDiscreteFunctionalAttributeParameter], optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -131,7 +127,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_parameter.py index 84f6fb1ef..3572c4903 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_discrete_parameter.py @@ -68,24 +68,20 @@ class GsaUpdateDiscreteParameter(GsaUpdateParameter): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "name": "str", - "values": "list[GsaUpdateDiscreteParameterValue]", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "name": "name", - "values": "values", } - subtype_mapping: dict[str, str] = { - "values": "GsaUpdateDiscreteParameterValue", - } + subtype_mapping: dict[str, str] = {} discriminator: Optional[str] = None @@ -94,10 +90,9 @@ def __init__( *, type: "GsaParameterType" = GsaParameterType.DISCRETE, default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, - values: "list[GsaUpdateDiscreteParameterValue] | Unset_Type" = Unset, ) -> None: """GsaUpdateDiscreteParameter - a model defined in Swagger @@ -105,49 +100,17 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional name: str, optional - values: list[GsaUpdateDiscreteParameterValue], optional """ super().__init__( type=type, default_parameter_value_guid=default_parameter_value_guid, - default_parameter_value_index=default_parameter_value_index, guid=guid, + help_path=help_path, name=name, ) - self._values: list[GsaUpdateDiscreteParameterValue] | Unset_Type = Unset - - if values is not Unset: - self.values = values - - @property - def values(self) -> "list[GsaUpdateDiscreteParameterValue] | Unset_Type": - """Gets the values of this GsaUpdateDiscreteParameter. - Update the set of parameter values. This can result in adding, modifying, deleting and reordering parameter values. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a name. - - Returns - ------- - list[GsaUpdateDiscreteParameterValue] | Unset_Type - The values of this GsaUpdateDiscreteParameter. - """ - return self._values - - @values.setter - def values(self, values: "list[GsaUpdateDiscreteParameterValue] | Unset_Type") -> None: - """Sets the values of this GsaUpdateDiscreteParameter. - Update the set of parameter values. This can result in adding, modifying, deleting and reordering parameter values. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a name. - - Parameters - ---------- - values: list[GsaUpdateDiscreteParameterValue] | Unset_Type - The values of this GsaUpdateDiscreteParameter. - """ - # Field is not nullable - if values is None: - raise ValueError("Invalid value for 'values', must not be 'None'") - self._values = values @classmethod def get_real_child_model(cls, data: dict[str, str]) -> str: diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names.py deleted file mode 100644 index b1e73829e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names.py +++ /dev/null @@ -1,147 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDisplayNames(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "GsaGrid", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - } - - subtype_mapping: dict[str, str] = { - "displayNames": "GsaGrid", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "GsaGrid | Unset_Type" = Unset, - ) -> None: - """GsaUpdateDisplayNames - a model defined in Swagger - - Parameters - ---------- - display_names: GsaGrid, optional - """ - self._display_names: GsaGrid | Unset_Type = Unset - - if display_names is not Unset: - self.display_names = display_names - - @property - def display_names(self) -> "GsaGrid | Unset_Type": - """Gets the display_names of this GsaUpdateDisplayNames. - - Returns - ------- - GsaGrid | Unset_Type - The display_names of this GsaUpdateDisplayNames. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "GsaGrid | Unset_Type") -> None: - """Sets the display_names of this GsaUpdateDisplayNames. - - Parameters - ---------- - display_names: GsaGrid | Unset_Type - The display_names of this GsaUpdateDisplayNames. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - self._display_names = display_names - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDisplayNames): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names_response.py deleted file mode 100644 index a3d6d8d76..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_display_names_response.py +++ /dev/null @@ -1,181 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateDisplayNamesResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "number_deleted": "int", - "number_updated": "int", - } - - attribute_map: dict[str, str] = { - "number_deleted": "numberDeleted", - "number_updated": "numberUpdated", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - number_deleted: "int", - number_updated: "int", - ) -> None: - """GsaUpdateDisplayNamesResponse - a model defined in Swagger - - Parameters - ---------- - number_deleted: int - number_updated: int - """ - self._number_updated: int - self._number_deleted: int - - self.number_updated = number_updated - self.number_deleted = number_deleted - - @property - def number_updated(self) -> "int": - """Gets the number_updated of this GsaUpdateDisplayNamesResponse. - - Returns - ------- - int - The number_updated of this GsaUpdateDisplayNamesResponse. - """ - return self._number_updated - - @number_updated.setter - def number_updated(self, number_updated: "int") -> None: - """Sets the number_updated of this GsaUpdateDisplayNamesResponse. - - Parameters - ---------- - number_updated: int - The number_updated of this GsaUpdateDisplayNamesResponse. - """ - # Field is not nullable - if number_updated is None: - raise ValueError("Invalid value for 'number_updated', must not be 'None'") - # Field is required - if number_updated is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_updated', must not be 'Unset'") - self._number_updated = number_updated - - @property - def number_deleted(self) -> "int": - """Gets the number_deleted of this GsaUpdateDisplayNamesResponse. - - Returns - ------- - int - The number_deleted of this GsaUpdateDisplayNamesResponse. - """ - return self._number_deleted - - @number_deleted.setter - def number_deleted(self, number_deleted: "int") -> None: - """Sets the number_deleted of this GsaUpdateDisplayNamesResponse. - - Parameters - ---------- - number_deleted: int - The number_deleted of this GsaUpdateDisplayNamesResponse. - """ - # Field is not nullable - if number_deleted is None: - raise ValueError("Invalid value for 'number_deleted', must not be 'None'") - # Field is required - if number_deleted is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'number_deleted', must not be 'Unset'") - self._number_deleted = number_deleted - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateDisplayNamesResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_smart_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_dynamic_record_link_group.py similarity index 85% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_smart_record_link_group.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_dynamic_record_link_group.py index f04206125..cd643c571 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_smart_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_dynamic_record_link_group.py @@ -49,7 +49,7 @@ from . import * -class GsaUpdateSmartRecordLinkGroup(GsaUpdateRecordLinkGroup): +class GsaUpdateDynamicRecordLinkGroup(GsaUpdateRecordLinkGroup): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -97,7 +97,7 @@ class GsaUpdateSmartRecordLinkGroup(GsaUpdateRecordLinkGroup): def __init__( self, *, - type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.SMART, + type: "GsaRecordLinkGroupType" = GsaRecordLinkGroupType.DYNAMIC, attribute_pairs: "list[GsaCreateAttributeLinkPair] | Unset_Type" = Unset, forbid_orphans: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, @@ -105,7 +105,7 @@ def __init__( referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" = Unset, reverse_name: "str | Unset_Type" = Unset, ) -> None: - """GsaUpdateSmartRecordLinkGroup - a model defined in Swagger + """GsaUpdateDynamicRecordLinkGroup - a model defined in Swagger Parameters ---------- @@ -131,23 +131,23 @@ def __init__( @property def forbid_orphans(self) -> "bool | Unset_Type": - """Gets the forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + """Gets the forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. Returns ------- bool | Unset_Type - The forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + The forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. """ return self._forbid_orphans @forbid_orphans.setter def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: - """Sets the forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + """Sets the forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- forbid_orphans: bool | Unset_Type - The forbid_orphans of this GsaUpdateSmartRecordLinkGroup. + The forbid_orphans of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if forbid_orphans is None: @@ -156,12 +156,12 @@ def forbid_orphans(self, forbid_orphans: "bool | Unset_Type") -> None: @property def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_Type": - """Gets the referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + """Gets the referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. Returns ------- GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + The referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. """ return self._referential_integrity_model @@ -169,12 +169,12 @@ def referential_integrity_model(self) -> "GsaReferentialIntegrityModel | Unset_T def referential_integrity_model( self, referential_integrity_model: "GsaReferentialIntegrityModel | Unset_Type" ) -> None: - """Sets the referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + """Sets the referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- referential_integrity_model: GsaReferentialIntegrityModel | Unset_Type - The referential_integrity_model of this GsaUpdateSmartRecordLinkGroup. + The referential_integrity_model of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if referential_integrity_model is None: @@ -183,13 +183,12 @@ def referential_integrity_model( @property def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair] | Unset_Type": - """Gets the attribute_pairs of this GsaUpdateSmartRecordLinkGroup. - The attribute pairs cannot be updated other than by creating a new set. There must be at least one and not more than three attribute pairs. + """Gets the attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. Returns ------- list[GsaCreateAttributeLinkPair] | Unset_Type - The attribute_pairs of this GsaUpdateSmartRecordLinkGroup. + The attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. """ return self._attribute_pairs @@ -197,13 +196,12 @@ def attribute_pairs(self) -> "list[GsaCreateAttributeLinkPair] | Unset_Type": def attribute_pairs( self, attribute_pairs: "list[GsaCreateAttributeLinkPair] | Unset_Type" ) -> None: - """Sets the attribute_pairs of this GsaUpdateSmartRecordLinkGroup. - The attribute pairs cannot be updated other than by creating a new set. There must be at least one and not more than three attribute pairs. + """Sets the attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. Parameters ---------- attribute_pairs: list[GsaCreateAttributeLinkPair] | Unset_Type - The attribute_pairs of this GsaUpdateSmartRecordLinkGroup. + The attribute_pairs of this GsaUpdateDynamicRecordLinkGroup. """ # Field is not nullable if attribute_pairs is None: @@ -232,7 +230,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateSmartRecordLinkGroup): + if not isinstance(other, GsaUpdateDynamicRecordLinkGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_file_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_file_attribute.py index eeea46d3c..09c31cf77 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_file_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_file_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateFileAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdateFileAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_float_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_float_functional_attribute.py index 0a8faaf00..6db51484c 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_float_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_float_functional_attribute.py @@ -71,7 +71,6 @@ class GsaUpdateFloatFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "list[GsaUpdateFloatFunctionalAttributeParameter]", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -86,7 +85,6 @@ class GsaUpdateFloatFunctionalAttribute(GsaUpdateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -110,7 +108,6 @@ def __init__( attribute_parameters: "list[GsaUpdateFloatFunctionalAttributeParameter] | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -127,7 +124,6 @@ def __init__( attribute_parameters: list[GsaUpdateFloatFunctionalAttributeParameter], optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -140,7 +136,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_hyperlink_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_hyperlink_attribute.py index 2f83249d8..5be3accb6 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_hyperlink_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_hyperlink_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateHyperlinkAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdateHyperlinkAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_integer_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_integer_attribute.py index a8f3f56f2..491418323 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_integer_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_integer_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateIntegerAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -83,7 +82,6 @@ class GsaUpdateIntegerAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -102,7 +100,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -117,7 +114,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -129,7 +125,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_layout_section.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_layout_section.py deleted file mode 100644 index 3f0eb71f2..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_layout_section.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateLayoutSection(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "section_items": "list[GsaPutLayoutItem]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "section_items": "sectionItems", - } - - subtype_mapping: dict[str, str] = { - "sectionItems": "GsaPutLayoutItem", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - section_items: "list[GsaPutLayoutItem] | Unset_Type" = Unset, - ) -> None: - """GsaUpdateLayoutSection - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - section_items: list[GsaPutLayoutItem], optional - """ - self._section_items: list[GsaPutLayoutItem] | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if section_items is not Unset: - self.section_items = section_items - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def section_items(self) -> "list[GsaPutLayoutItem] | Unset_Type": - """Gets the section_items of this GsaUpdateLayoutSection. - Update the set of items, in order. If an existing item is not included, it will be deleted. - - Returns - ------- - list[GsaPutLayoutItem] | Unset_Type - The section_items of this GsaUpdateLayoutSection. - """ - return self._section_items - - @section_items.setter - def section_items(self, section_items: "list[GsaPutLayoutItem] | Unset_Type") -> None: - """Sets the section_items of this GsaUpdateLayoutSection. - Update the set of items, in order. If an existing item is not included, it will be deleted. - - Parameters - ---------- - section_items: list[GsaPutLayoutItem] | Unset_Type - The section_items of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if section_items is None: - raise ValueError("Invalid value for 'section_items', must not be 'None'") - self._section_items = section_items - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdateLayoutSection. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdateLayoutSection. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdateLayoutSection. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdateLayoutSection. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdateLayoutSection. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdateLayoutSection. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdateLayoutSection. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateLayoutSection): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_logical_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_logical_attribute.py index bf8a56e1f..410e665d0 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_logical_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_logical_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateLogicalAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdateLogicalAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_long_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_long_text_attribute.py index 57e9142fe..3a28ca02d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_long_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_long_text_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateLongTextAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdateLongTextAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_maths_functional_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_maths_functional_attribute.py index 1fe2cb1bd..46687ed71 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_maths_functional_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_maths_functional_attribute.py @@ -75,7 +75,6 @@ class GsaUpdateMathsFunctionalAttribute(GsaUpdateAttribute): "axis_name": "GsaUpdateAxisName", "default_content": "GsaUpdateMathsContent", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "expressions": "list[GsaSlimEntity]", "guid": "str", "help_path": "str", @@ -95,7 +94,6 @@ class GsaUpdateMathsFunctionalAttribute(GsaUpdateAttribute): "axis_name": "axisName", "default_content": "defaultContent", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "expressions": "expressions", "guid": "guid", "help_path": "helpPath", @@ -126,7 +124,6 @@ def __init__( axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_content: "GsaUpdateMathsContent | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, expressions: "list[GsaSlimEntity] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, @@ -148,7 +145,6 @@ def __init__( axis_name: GsaUpdateAxisName, optional default_content: GsaUpdateMathsContent, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional expressions: list[GsaSlimEntity] | None, optional guid: str, optional help_path: str | None, optional @@ -162,7 +158,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_numeric_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_numeric_parameter.py index 3923fb196..8948fd019 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_numeric_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_numeric_parameter.py @@ -68,30 +68,27 @@ class GsaUpdateNumericParameter(GsaUpdateParameter): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "interpolation_type": "GsaParameterInterpolationType", "name": "str", "scale_type": "GsaParameterScaleType", "unit": "GsaSlimEntity", - "values": "list[GsaUpdateNumericParameterValue]", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "interpolation_type": "interpolationType", "name": "name", "scale_type": "scaleType", "unit": "unit", - "values": "values", } subtype_mapping: dict[str, str] = { "unit": "GsaSlimEntity", - "values": "GsaUpdateNumericParameterValue", "interpolationType": "GsaParameterInterpolationType", "scaleType": "GsaParameterScaleType", } @@ -103,13 +100,12 @@ def __init__( *, type: "GsaParameterType" = GsaParameterType.NUMERIC, default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, interpolation_type: "GsaParameterInterpolationType | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, scale_type: "GsaParameterScaleType | Unset_Type" = Unset, unit: "GsaSlimEntity | Unset_Type" = Unset, - values: "list[GsaUpdateNumericParameterValue] | Unset_Type" = Unset, ) -> None: """GsaUpdateNumericParameter - a model defined in Swagger @@ -117,30 +113,26 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional interpolation_type: GsaParameterInterpolationType, optional name: str, optional scale_type: GsaParameterScaleType, optional unit: GsaSlimEntity, optional - values: list[GsaUpdateNumericParameterValue], optional """ super().__init__( type=type, default_parameter_value_guid=default_parameter_value_guid, - default_parameter_value_index=default_parameter_value_index, guid=guid, + help_path=help_path, name=name, ) self._unit: GsaSlimEntity | Unset_Type = Unset - self._values: list[GsaUpdateNumericParameterValue] | Unset_Type = Unset self._interpolation_type: GsaParameterInterpolationType | Unset_Type = Unset self._scale_type: GsaParameterScaleType | Unset_Type = Unset if unit is not Unset: self.unit = unit - if values is not Unset: - self.values = values if interpolation_type is not Unset: self.interpolation_type = interpolation_type if scale_type is not Unset: @@ -171,33 +163,6 @@ def unit(self, unit: "GsaSlimEntity | Unset_Type") -> None: raise ValueError("Invalid value for 'unit', must not be 'None'") self._unit = unit - @property - def values(self) -> "list[GsaUpdateNumericParameterValue] | Unset_Type": - """Gets the values of this GsaUpdateNumericParameter. - Update the set of parameter values. This can result in adding, modifying and deleting parameter values. Numeric parameter values can not be reordered - they are ordered by numeric value. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a value. - - Returns - ------- - list[GsaUpdateNumericParameterValue] | Unset_Type - The values of this GsaUpdateNumericParameter. - """ - return self._values - - @values.setter - def values(self, values: "list[GsaUpdateNumericParameterValue] | Unset_Type") -> None: - """Sets the values of this GsaUpdateNumericParameter. - Update the set of parameter values. This can result in adding, modifying and deleting parameter values. Numeric parameter values can not be reordered - they are ordered by numeric value. Existing parameter values will be matched by GUID. If an existing parameter value is not included, it will be deleted. If a GUID is not provided, or the GUID does not match an existing value, a new value will be created. New values must have a value. - - Parameters - ---------- - values: list[GsaUpdateNumericParameterValue] | Unset_Type - The values of this GsaUpdateNumericParameter. - """ - # Field is not nullable - if values is None: - raise ValueError("Invalid value for 'values', must not be 'None'") - self._values = values - @property def interpolation_type(self) -> "GsaParameterInterpolationType | Unset_Type": """Gets the interpolation_type of this GsaUpdateNumericParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_parameter.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_parameter.py index 3916aa876..b5562929a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_parameter.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_parameter.py @@ -65,16 +65,16 @@ class GsaUpdateParameter(ModelBase): swagger_types: dict[str, str] = { "type": "GsaParameterType", "default_parameter_value_guid": "str", - "default_parameter_value_index": "int", "guid": "str", + "help_path": "str", "name": "str", } attribute_map: dict[str, str] = { "type": "type", "default_parameter_value_guid": "defaultParameterValueGuid", - "default_parameter_value_index": "defaultParameterValueIndex", "guid": "guid", + "help_path": "helpPath", "name": "name", } @@ -94,8 +94,8 @@ def __init__( *, type: "GsaParameterType", default_parameter_value_guid: "str | Unset_Type" = Unset, - default_parameter_value_index: "int | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, + help_path: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, ) -> None: """GsaUpdateParameter - a model defined in Swagger @@ -104,21 +104,21 @@ def __init__( ---------- type: GsaParameterType default_parameter_value_guid: str, optional - default_parameter_value_index: int, optional guid: str, optional + help_path: str | None, optional name: str, optional """ self._type: GsaParameterType + self._help_path: str | None | Unset_Type = Unset self._default_parameter_value_guid: str | Unset_Type = Unset - self._default_parameter_value_index: int | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset self.type = type + if help_path is not Unset: + self.help_path = help_path if default_parameter_value_guid is not Unset: self.default_parameter_value_guid = default_parameter_value_guid - if default_parameter_value_index is not Unset: - self.default_parameter_value_index = default_parameter_value_index if name is not Unset: self.name = name if guid is not Unset: @@ -152,10 +152,31 @@ def type(self, type: "GsaParameterType") -> None: raise ValueError("Invalid value for 'type', must not be 'Unset'") self._type = type + @property + def help_path(self) -> "str | None | Unset_Type": + """Gets the help_path of this GsaUpdateParameter. + + Returns + ------- + str | None | Unset_Type + The help_path of this GsaUpdateParameter. + """ + return self._help_path + + @help_path.setter + def help_path(self, help_path: "str | None | Unset_Type") -> None: + """Sets the help_path of this GsaUpdateParameter. + + Parameters + ---------- + help_path: str | None | Unset_Type + The help_path of this GsaUpdateParameter. + """ + self._help_path = help_path + @property def default_parameter_value_guid(self) -> "str | Unset_Type": """Gets the default_parameter_value_guid of this GsaUpdateParameter. - Use to set the default value when the parameter value GUID is known. Returns ------- @@ -169,7 +190,6 @@ def default_parameter_value_guid( self, default_parameter_value_guid: "str | Unset_Type" ) -> None: """Sets the default_parameter_value_guid of this GsaUpdateParameter. - Use to set the default value when the parameter value GUID is known. Parameters ---------- @@ -181,37 +201,6 @@ def default_parameter_value_guid( raise ValueError("Invalid value for 'default_parameter_value_guid', must not be 'None'") self._default_parameter_value_guid = default_parameter_value_guid - @property - def default_parameter_value_index(self) -> "int | Unset_Type": - """Gets the default_parameter_value_index of this GsaUpdateParameter. - Use to set the default value when also updating parameter values, if the parameter value GUID is not known. For example when creating a new parameter value. - - Returns - ------- - int | Unset_Type - The default_parameter_value_index of this GsaUpdateParameter. - """ - return self._default_parameter_value_index - - @default_parameter_value_index.setter - def default_parameter_value_index( - self, default_parameter_value_index: "int | Unset_Type" - ) -> None: - """Sets the default_parameter_value_index of this GsaUpdateParameter. - Use to set the default value when also updating parameter values, if the parameter value GUID is not known. For example when creating a new parameter value. - - Parameters - ---------- - default_parameter_value_index: int | Unset_Type - The default_parameter_value_index of this GsaUpdateParameter. - """ - # Field is not nullable - if default_parameter_value_index is None: - raise ValueError( - "Invalid value for 'default_parameter_value_index', must not be 'None'" - ) - self._default_parameter_value_index = default_parameter_value_index - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateParameter. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission.py deleted file mode 100644 index 5653921d1..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission.py +++ /dev/null @@ -1,300 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermission(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "description": "str", - "guid": "str", - "name": "str", - "role": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "description": "description", - "guid": "guid", - "name": "name", - "role": "role", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - description: "str | None | Unset_Type" = Unset, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - role: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermission - a model defined in Swagger - - Parameters - ---------- - description: str | None, optional - guid: str, optional - name: str, optional - role: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - self._role: str | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if role is not Unset: - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def role(self) -> "str | Unset_Type": - """Gets the role of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The role of this GsaUpdatePermission. - """ - return self._role - - @role.setter - def role(self, role: "str | Unset_Type") -> None: - """Sets the role of this GsaUpdatePermission. - - Parameters - ---------- - role: str | Unset_Type - The role of this GsaUpdatePermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaUpdatePermission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaUpdatePermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaUpdatePermission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaUpdatePermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaUpdatePermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaUpdatePermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaUpdatePermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaUpdatePermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaUpdatePermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaUpdatePermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaUpdatePermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaUpdatePermission. - """ - self._unset_message = unset_message - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePermission. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePermission. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdatePermission. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdatePermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdatePermission. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdatePermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_access_control.py deleted file mode 100644 index 88017b89e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_access_control.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "permission": "GsaSlimEntity", - "can_read": "bool", - "can_write": "bool", - } - - attribute_map: dict[str, str] = { - "permission": "permission", - "can_read": "canRead", - "can_write": "canWrite", - } - - subtype_mapping: dict[str, str] = { - "permission": "GsaSlimEntity", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - permission: "GsaSlimEntity", - can_read: "bool | Unset_Type" = Unset, - can_write: "bool | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermissionAccessControl - a model defined in Swagger - - Parameters - ---------- - permission: GsaSlimEntity - can_read: bool, optional - can_write: bool, optional - """ - self._permission: GsaSlimEntity - self._can_read: bool | Unset_Type = Unset - self._can_write: bool | Unset_Type = Unset - - self.permission = permission - if can_read is not Unset: - self.can_read = can_read - if can_write is not Unset: - self.can_write = can_write - - @property - def permission(self) -> "GsaSlimEntity": - """Gets the permission of this GsaUpdatePermissionAccessControl. - - Returns - ------- - GsaSlimEntity - The permission of this GsaUpdatePermissionAccessControl. - """ - return self._permission - - @permission.setter - def permission(self, permission: "GsaSlimEntity") -> None: - """Sets the permission of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - permission: GsaSlimEntity - The permission of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if permission is None: - raise ValueError("Invalid value for 'permission', must not be 'None'") - # Field is required - if permission is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission', must not be 'Unset'") - self._permission = permission - - @property - def can_read(self) -> "bool | Unset_Type": - """Gets the can_read of this GsaUpdatePermissionAccessControl. - - Returns - ------- - bool | Unset_Type - The can_read of this GsaUpdatePermissionAccessControl. - """ - return self._can_read - - @can_read.setter - def can_read(self, can_read: "bool | Unset_Type") -> None: - """Sets the can_read of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - can_read: bool | Unset_Type - The can_read of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if can_read is None: - raise ValueError("Invalid value for 'can_read', must not be 'None'") - self._can_read = can_read - - @property - def can_write(self) -> "bool | Unset_Type": - """Gets the can_write of this GsaUpdatePermissionAccessControl. - - Returns - ------- - bool | Unset_Type - The can_write of this GsaUpdatePermissionAccessControl. - """ - return self._can_write - - @can_write.setter - def can_write(self, can_write: "bool | Unset_Type") -> None: - """Sets the can_write of this GsaUpdatePermissionAccessControl. - - Parameters - ---------- - can_write: bool | Unset_Type - The can_write of this GsaUpdatePermissionAccessControl. - """ - # Field is not nullable - if can_write is None: - raise ValueError("Invalid value for 'can_write', must not be 'None'") - self._can_write = can_write - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_based_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_based_access_control.py deleted file mode 100644 index 77d0de3ea..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_based_access_control.py +++ /dev/null @@ -1,124 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_access_control_mode import ( - GsaAccessControlMode, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_update_access_control import ( # noqa: F401 - GsaUpdateAccessControl, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionBasedAccessControl(GsaUpdateAccessControl): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "mode": "GsaAccessControlMode", - } - - attribute_map: dict[str, str] = { - "mode": "mode", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - mode: "GsaAccessControlMode" = GsaAccessControlMode.PERMISSIONBASED, - ) -> None: - """GsaUpdatePermissionBasedAccessControl - a model defined in Swagger - - Parameters - ---------- - mode: GsaAccessControlMode - """ - super().__init__(mode=mode) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionBasedAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category.py deleted file mode 100644 index b3f404c30..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category.py +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategory(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "permissions": "list[GsaPutPermission]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "permissions": "permissions", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaPutPermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - permissions: "list[GsaPutPermission] | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePermissionCategory - a model defined in Swagger - - Parameters - ---------- - guid: str, optional - name: str, optional - permissions: list[GsaPutPermission], optional - """ - self._permissions: list[GsaPutPermission] | Unset_Type = Unset - self._name: str | Unset_Type = Unset - self._guid: str | Unset_Type = Unset - - if permissions is not Unset: - self.permissions = permissions - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def permissions(self) -> "list[GsaPutPermission] | Unset_Type": - """Gets the permissions of this GsaUpdatePermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaPutPermission] | Unset_Type") -> None: - """Sets the permissions of this GsaUpdatePermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Parameters - ---------- - permissions: list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - self._permissions = permissions - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePermissionCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePermissionCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def guid(self) -> "str | Unset_Type": - """Gets the guid of this GsaUpdatePermissionCategory. - - Returns - ------- - str | Unset_Type - The guid of this GsaUpdatePermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | Unset_Type") -> None: - """Sets the guid of this GsaUpdatePermissionCategory. - - Parameters - ---------- - guid: str | Unset_Type - The guid of this GsaUpdatePermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control.py deleted file mode 100644 index c82017acb..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control.py +++ /dev/null @@ -1,186 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategoryAccessControl(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category": "GsaSlimEntity", - "permission_access_controls": "list[GsaUpdatePermissionAccessControl]", - } - - attribute_map: dict[str, str] = { - "category": "category", - "permission_access_controls": "permissionAccessControls", - } - - subtype_mapping: dict[str, str] = { - "category": "GsaSlimEntity", - "permissionAccessControls": "GsaUpdatePermissionAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category: "GsaSlimEntity", - permission_access_controls: "list[GsaUpdatePermissionAccessControl]", - ) -> None: - """GsaUpdatePermissionCategoryAccessControl - a model defined in Swagger - - Parameters - ---------- - category: GsaSlimEntity - permission_access_controls: list[GsaUpdatePermissionAccessControl] - """ - self._category: GsaSlimEntity - self._permission_access_controls: list[GsaUpdatePermissionAccessControl] - - self.category = category - self.permission_access_controls = permission_access_controls - - @property - def category(self) -> "GsaSlimEntity": - """Gets the category of this GsaUpdatePermissionCategoryAccessControl. - - Returns - ------- - GsaSlimEntity - The category of this GsaUpdatePermissionCategoryAccessControl. - """ - return self._category - - @category.setter - def category(self, category: "GsaSlimEntity") -> None: - """Sets the category of this GsaUpdatePermissionCategoryAccessControl. - - Parameters - ---------- - category: GsaSlimEntity - The category of this GsaUpdatePermissionCategoryAccessControl. - """ - # Field is not nullable - if category is None: - raise ValueError("Invalid value for 'category', must not be 'None'") - # Field is required - if category is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category', must not be 'Unset'") - self._category = category - - @property - def permission_access_controls(self) -> "list[GsaUpdatePermissionAccessControl]": - """Gets the permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - - Returns - ------- - list[GsaUpdatePermissionAccessControl] - The permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - """ - return self._permission_access_controls - - @permission_access_controls.setter - def permission_access_controls( - self, permission_access_controls: "list[GsaUpdatePermissionAccessControl]" - ) -> None: - """Sets the permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - - Parameters - ---------- - permission_access_controls: list[GsaUpdatePermissionAccessControl] - The permission_access_controls of this GsaUpdatePermissionCategoryAccessControl. - """ - # Field is not nullable - if permission_access_controls is None: - raise ValueError("Invalid value for 'permission_access_controls', must not be 'None'") - # Field is required - if permission_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'permission_access_controls', must not be 'Unset'") - self._permission_access_controls = permission_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategoryAccessControl): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control_request.py deleted file mode 100644 index 18cdc4659..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_permission_category_access_control_request.py +++ /dev/null @@ -1,151 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePermissionCategoryAccessControlRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "category_access_controls": "list[GsaUpdatePermissionCategoryAccessControl]", - } - - attribute_map: dict[str, str] = { - "category_access_controls": "categoryAccessControls", - } - - subtype_mapping: dict[str, str] = { - "categoryAccessControls": "GsaUpdatePermissionCategoryAccessControl", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]", - ) -> None: - """GsaUpdatePermissionCategoryAccessControlRequest - a model defined in Swagger - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - """ - self._category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - - self.category_access_controls = category_access_controls - - @property - def category_access_controls(self) -> "list[GsaUpdatePermissionCategoryAccessControl]": - """Gets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - - Returns - ------- - list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - """ - return self._category_access_controls - - @category_access_controls.setter - def category_access_controls( - self, category_access_controls: "list[GsaUpdatePermissionCategoryAccessControl]" - ) -> None: - """Sets the category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - - Parameters - ---------- - category_access_controls: list[GsaUpdatePermissionCategoryAccessControl] - The category_access_controls of this GsaUpdatePermissionCategoryAccessControlRequest. - """ - # Field is not nullable - if category_access_controls is None: - raise ValueError("Invalid value for 'category_access_controls', must not be 'None'") - # Field is required - if category_access_controls is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'category_access_controls', must not be 'Unset'") - self._category_access_controls = category_access_controls - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePermissionCategoryAccessControlRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_picture_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_picture_attribute.py index 7a9a001d7..3b8fbe327 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_picture_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_picture_attribute.py @@ -70,7 +70,6 @@ class GsaUpdatePictureAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -82,7 +81,6 @@ class GsaUpdatePictureAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -100,7 +98,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -114,7 +111,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -125,7 +121,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_point_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_point_attribute.py index 0b2ea0ff6..1668d70a5 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_point_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_point_attribute.py @@ -71,7 +71,6 @@ class GsaUpdatePointAttribute(GsaUpdateAttribute): "attribute_parameters": "list[GsaSlimEntity]", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -86,7 +85,6 @@ class GsaUpdatePointAttribute(GsaUpdateAttribute): "attribute_parameters": "attributeParameters", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -110,7 +108,6 @@ def __init__( attribute_parameters: "list[GsaSlimEntity] | None | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -127,7 +124,6 @@ def __init__( attribute_parameters: list[GsaSlimEntity] | None, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -140,7 +136,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_layout_item.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_layout_item.py deleted file mode 100644 index 29544ef2f..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_layout_item.py +++ /dev/null @@ -1,157 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_layout_item import ( # noqa: F401 - GsaPutLayoutItem, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutLayoutItem(GsaPutLayoutItem): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - ) -> None: - """GsaUpdatePutLayoutItem - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - """ - super().__init__(type=type) - self._guid: str - - self.guid = guid - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutLayoutItem. - - Returns - ------- - str - The guid of this GsaUpdatePutLayoutItem. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutLayoutItem. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutLayoutItem. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutLayoutItem): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission.py deleted file mode 100644 index ad45107be..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission.py +++ /dev/null @@ -1,314 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_permission import ( # noqa: F401 - GsaPutPermission, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutPermission(GsaPutPermission): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - "description": "str", - "name": "str", - "role": "str", - "set_message": "str", - "unset_message": "str", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - "description": "description", - "name": "name", - "role": "role", - "set_message": "setMessage", - "unset_message": "unsetMessage", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - description: "str | None | Unset_Type" = Unset, - name: "str | Unset_Type" = Unset, - role: "str | Unset_Type" = Unset, - set_message: "str | None | Unset_Type" = Unset, - unset_message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePutPermission - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - description: str | None, optional - name: str, optional - role: str, optional - set_message: str | None, optional - unset_message: str | None, optional - """ - super().__init__(type=type) - self._guid: str - self._name: str | Unset_Type = Unset - self._role: str | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._set_message: str | None | Unset_Type = Unset - self._unset_message: str | None | Unset_Type = Unset - - self.guid = guid - if name is not Unset: - self.name = name - if role is not Unset: - self.role = role - if description is not Unset: - self.description = description - if set_message is not Unset: - self.set_message = set_message - if unset_message is not Unset: - self.unset_message = unset_message - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutPermission. - - Returns - ------- - str - The guid of this GsaUpdatePutPermission. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutPermission. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutPermission. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePutPermission. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePutPermission. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePutPermission. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePutPermission. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def role(self) -> "str | Unset_Type": - """Gets the role of this GsaUpdatePutPermission. - - Returns - ------- - str | Unset_Type - The role of this GsaUpdatePutPermission. - """ - return self._role - - @role.setter - def role(self, role: "str | Unset_Type") -> None: - """Sets the role of this GsaUpdatePutPermission. - - Parameters - ---------- - role: str | Unset_Type - The role of this GsaUpdatePutPermission. - """ - # Field is not nullable - if role is None: - raise ValueError("Invalid value for 'role', must not be 'None'") - self._role = role - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaUpdatePutPermission. - The description of the permission. - - Returns - ------- - str | None | Unset_Type - The description of this GsaUpdatePutPermission. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaUpdatePutPermission. - The description of the permission. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaUpdatePutPermission. - """ - self._description = description - - @property - def set_message(self) -> "str | None | Unset_Type": - """Gets the set_message of this GsaUpdatePutPermission. - Message to show when this permission is set. - - Returns - ------- - str | None | Unset_Type - The set_message of this GsaUpdatePutPermission. - """ - return self._set_message - - @set_message.setter - def set_message(self, set_message: "str | None | Unset_Type") -> None: - """Sets the set_message of this GsaUpdatePutPermission. - Message to show when this permission is set. - - Parameters - ---------- - set_message: str | None | Unset_Type - The set_message of this GsaUpdatePutPermission. - """ - self._set_message = set_message - - @property - def unset_message(self) -> "str | None | Unset_Type": - """Gets the unset_message of this GsaUpdatePutPermission. - Message to show when this permission is not set. - - Returns - ------- - str | None | Unset_Type - The unset_message of this GsaUpdatePutPermission. - """ - return self._unset_message - - @unset_message.setter - def unset_message(self, unset_message: "str | None | Unset_Type") -> None: - """Sets the unset_message of this GsaUpdatePutPermission. - Message to show when this permission is not set. - - Parameters - ---------- - unset_message: str | None | Unset_Type - The unset_message of this GsaUpdatePutPermission. - """ - self._unset_message = unset_message - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutPermission): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission_category.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission_category.py deleted file mode 100644 index 8446dea5e..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_put_permission_category.py +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_permission_category import ( # noqa: F401 - GsaPutPermissionCategory, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_put_type import GsaPutType - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdatePutPermissionCategory(GsaPutPermissionCategory): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "type": "GsaPutType", - "name": "str", - "permissions": "list[GsaPutPermission]", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "type": "type", - "name": "name", - "permissions": "permissions", - } - - subtype_mapping: dict[str, str] = { - "permissions": "GsaPutPermission", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - type: "GsaPutType" = GsaPutType.UPDATE, - name: "str | Unset_Type" = Unset, - permissions: "list[GsaPutPermission] | Unset_Type" = Unset, - ) -> None: - """GsaUpdatePutPermissionCategory - a model defined in Swagger - - Parameters - ---------- - guid: str - type: GsaPutType - name: str, optional - permissions: list[GsaPutPermission], optional - """ - super().__init__(type=type) - self._guid: str - self._name: str | Unset_Type = Unset - self._permissions: list[GsaPutPermission] | Unset_Type = Unset - - self.guid = guid - if name is not Unset: - self.name = name - if permissions is not Unset: - self.permissions = permissions - - @property - def guid(self) -> "str": - """Gets the guid of this GsaUpdatePutPermissionCategory. - - Returns - ------- - str - The guid of this GsaUpdatePutPermissionCategory. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaUpdatePutPermissionCategory. - - Parameters - ---------- - guid: str - The guid of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @property - def name(self) -> "str | Unset_Type": - """Gets the name of this GsaUpdatePutPermissionCategory. - - Returns - ------- - str | Unset_Type - The name of this GsaUpdatePutPermissionCategory. - """ - return self._name - - @name.setter - def name(self, name: "str | Unset_Type") -> None: - """Sets the name of this GsaUpdatePutPermissionCategory. - - Parameters - ---------- - name: str | Unset_Type - The name of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - self._name = name - - @property - def permissions(self) -> "list[GsaPutPermission] | Unset_Type": - """Gets the permissions of this GsaUpdatePutPermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Returns - ------- - list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePutPermissionCategory. - """ - return self._permissions - - @permissions.setter - def permissions(self, permissions: "list[GsaPutPermission] | Unset_Type") -> None: - """Sets the permissions of this GsaUpdatePutPermissionCategory. - This can result in adding, modifying and deleting permissions. To insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission). To modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission). Existing permissions will be matched by GUID. If an existing permission is not included, it will be deleted. - - Parameters - ---------- - permissions: list[GsaPutPermission] | Unset_Type - The permissions of this GsaUpdatePutPermissionCategory. - """ - # Field is not nullable - if permissions is None: - raise ValueError("Invalid value for 'permissions', must not be 'None'") - self._permissions = permissions - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdatePutPermissionCategory): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_range_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_range_attribute.py index 4eec8853e..7fffe644d 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_range_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_range_attribute.py @@ -70,7 +70,6 @@ class GsaUpdateRangeAttribute(GsaUpdateAttribute): "about_attribute": "GsaSlimEntity", "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -83,7 +82,6 @@ class GsaUpdateRangeAttribute(GsaUpdateAttribute): "about_attribute": "aboutAttribute", "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -104,7 +102,6 @@ def __init__( about_attribute: "GsaSlimEntity | Unset_Type" = Unset, axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -119,7 +116,6 @@ def __init__( about_attribute: GsaSlimEntity, optional axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -131,7 +127,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_record_link_group.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_record_link_group.py index 623002e49..9965a279e 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_record_link_group.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_record_link_group.py @@ -82,7 +82,7 @@ class GsaUpdateRecordLinkGroup(ModelBase): discriminator_value_class_map = { "static".lower(): "#/components/schemas/GsaUpdateStaticRecordLinkGroup", - "smart".lower(): "#/components/schemas/GsaUpdateSmartRecordLinkGroup", + "dynamic".lower(): "#/components/schemas/GsaUpdateDynamicRecordLinkGroup", "crossDatabase".lower(): "#/components/schemas/GsaUpdateCrossDatabaseRecordLinkGroup", } diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_root_folder_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_root_folder_error_detail.py deleted file mode 100644 index c657e0069..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_root_folder_error_detail.py +++ /dev/null @@ -1,128 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_detail import ( # noqa: F401 - GsaFolderErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_folder_error_reason import ( - GsaFolderErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpdateRootFolderErrorDetail(GsaFolderErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaFolderErrorReason", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaFolderErrorReason" = GsaFolderErrorReason.UPDATEROOT, - ) -> None: - """GsaUpdateRootFolderErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaFolderErrorReason - """ - super().__init__(message=message, reason=reason) - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpdateRootFolderErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_run_status.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_run_status.py deleted file mode 100644 index 5b4622527..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_run_status.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUpdateRunStatus(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - REGISTERED = "Registered" - UPLOADINPROGRESS = "UploadInProgress" - UPLOADED = "Uploaded" - UPLOADFAILED = "UploadFailed" - DRYRUNPENDING = "DryRunPending" - DRYRUNCANCELLING = "DryRunCancelling" - DRYRUNCANCELLED = "DryRunCancelled" - DRYRUNINPROGRESS = "DryRunInProgress" - DRYRUNCOMPLETE = "DryRunComplete" - DRYRUNFAILED = "DryRunFailed" - APPLYPENDING = "ApplyPending" - APPLYINPROGRESS = "ApplyInProgress" - APPLYCANCELLING = "ApplyCancelling" - APPLYCANCELLED = "ApplyCancelled" - APPLYCOMPLETE = "ApplyComplete" - APPLYFAILED = "ApplyFailed" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_short_text_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_short_text_attribute.py index 7316f6703..81360ca81 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_short_text_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_short_text_attribute.py @@ -71,7 +71,6 @@ class GsaUpdateShortTextAttribute(GsaUpdateAttribute): "axis_name": "GsaUpdateAxisName", "data_rule": "GsaSlimEntity", "default_threshold_type": "GsaAttributeThresholdType", - "display_names": "dict(str, str)", "guid": "str", "help_path": "str", "is_hidden_from_search_criteria": "bool", @@ -85,7 +84,6 @@ class GsaUpdateShortTextAttribute(GsaUpdateAttribute): "axis_name": "axisName", "data_rule": "dataRule", "default_threshold_type": "defaultThresholdType", - "display_names": "displayNames", "guid": "guid", "help_path": "helpPath", "is_hidden_from_search_criteria": "isHiddenFromSearchCriteria", @@ -107,7 +105,6 @@ def __init__( axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, data_rule: "GsaSlimEntity | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, is_hidden_from_search_criteria: "bool | None | Unset_Type" = Unset, @@ -123,7 +120,6 @@ def __init__( axis_name: GsaUpdateAxisName, optional data_rule: GsaSlimEntity, optional default_threshold_type: GsaAttributeThresholdType, optional - display_names: dict[str, str] | None, optional guid: str, optional help_path: str | None, optional is_hidden_from_search_criteria: bool | None, optional @@ -135,7 +131,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_table.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_table.py index 356fd158f..f6519023a 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_table.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_table.py @@ -61,33 +61,21 @@ class GsaUpdateTable(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "datasheet_footer": "str", - "datasheet_header": "str", "default_layout_guid": "str", "default_subset_guid": "str", "guid": "str", "is_hidden_from_browse": "bool", "is_hidden_from_search": "bool", - "legal_disclaimer": "str", "name": "str", - "quality_system_guid": "str", - "should_show_version_control_signatures": "bool", - "table_types": "list[str]", } attribute_map: dict[str, str] = { - "datasheet_footer": "datasheetFooter", - "datasheet_header": "datasheetHeader", "default_layout_guid": "defaultLayoutGuid", "default_subset_guid": "defaultSubsetGuid", "guid": "guid", "is_hidden_from_browse": "isHiddenFromBrowse", "is_hidden_from_search": "isHiddenFromSearch", - "legal_disclaimer": "legalDisclaimer", "name": "name", - "quality_system_guid": "qualitySystemGuid", - "should_show_version_control_signatures": "shouldShowVersionControlSignatures", - "table_types": "tableTypes", } subtype_mapping: dict[str, str] = {} @@ -97,46 +85,28 @@ class GsaUpdateTable(ModelBase): def __init__( self, *, - datasheet_footer: "str | None | Unset_Type" = Unset, - datasheet_header: "str | None | Unset_Type" = Unset, default_layout_guid: "str | None | Unset_Type" = Unset, default_subset_guid: "str | None | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, is_hidden_from_browse: "bool | Unset_Type" = Unset, is_hidden_from_search: "bool | Unset_Type" = Unset, - legal_disclaimer: "str | None | Unset_Type" = Unset, name: "str | Unset_Type" = Unset, - quality_system_guid: "str | None | Unset_Type" = Unset, - should_show_version_control_signatures: "bool | Unset_Type" = Unset, - table_types: "list[str] | None | Unset_Type" = Unset, ) -> None: """GsaUpdateTable - a model defined in Swagger Parameters ---------- - datasheet_footer: str | None, optional - datasheet_header: str | None, optional default_layout_guid: str | None, optional default_subset_guid: str | None, optional guid: str, optional is_hidden_from_browse: bool, optional is_hidden_from_search: bool, optional - legal_disclaimer: str | None, optional name: str, optional - quality_system_guid: str | None, optional - should_show_version_control_signatures: bool, optional - table_types: list[str] | None, optional """ self._is_hidden_from_browse: bool | Unset_Type = Unset self._is_hidden_from_search: bool | Unset_Type = Unset self._default_subset_guid: str | None | Unset_Type = Unset self._default_layout_guid: str | None | Unset_Type = Unset - self._quality_system_guid: str | None | Unset_Type = Unset - self._legal_disclaimer: str | None | Unset_Type = Unset - self._datasheet_header: str | None | Unset_Type = Unset - self._datasheet_footer: str | None | Unset_Type = Unset - self._table_types: list[str] | None | Unset_Type = Unset - self._should_show_version_control_signatures: bool | Unset_Type = Unset self._name: str | Unset_Type = Unset self._guid: str | Unset_Type = Unset @@ -148,18 +118,6 @@ def __init__( self.default_subset_guid = default_subset_guid if default_layout_guid is not Unset: self.default_layout_guid = default_layout_guid - if quality_system_guid is not Unset: - self.quality_system_guid = quality_system_guid - if legal_disclaimer is not Unset: - self.legal_disclaimer = legal_disclaimer - if datasheet_header is not Unset: - self.datasheet_header = datasheet_header - if datasheet_footer is not Unset: - self.datasheet_footer = datasheet_footer - if table_types is not Unset: - self.table_types = table_types - if should_show_version_control_signatures is not Unset: - self.should_show_version_control_signatures = should_show_version_control_signatures if name is not Unset: self.name = name if guid is not Unset: @@ -259,147 +217,6 @@ def default_layout_guid(self, default_layout_guid: "str | None | Unset_Type") -> """ self._default_layout_guid = default_layout_guid - @property - def quality_system_guid(self) -> "str | None | Unset_Type": - """Gets the quality_system_guid of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The quality_system_guid of this GsaUpdateTable. - """ - return self._quality_system_guid - - @quality_system_guid.setter - def quality_system_guid(self, quality_system_guid: "str | None | Unset_Type") -> None: - """Sets the quality_system_guid of this GsaUpdateTable. - - Parameters - ---------- - quality_system_guid: str | None | Unset_Type - The quality_system_guid of this GsaUpdateTable. - """ - self._quality_system_guid = quality_system_guid - - @property - def legal_disclaimer(self) -> "str | None | Unset_Type": - """Gets the legal_disclaimer of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The legal_disclaimer of this GsaUpdateTable. - """ - return self._legal_disclaimer - - @legal_disclaimer.setter - def legal_disclaimer(self, legal_disclaimer: "str | None | Unset_Type") -> None: - """Sets the legal_disclaimer of this GsaUpdateTable. - - Parameters - ---------- - legal_disclaimer: str | None | Unset_Type - The legal_disclaimer of this GsaUpdateTable. - """ - self._legal_disclaimer = legal_disclaimer - - @property - def datasheet_header(self) -> "str | None | Unset_Type": - """Gets the datasheet_header of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_header of this GsaUpdateTable. - """ - return self._datasheet_header - - @datasheet_header.setter - def datasheet_header(self, datasheet_header: "str | None | Unset_Type") -> None: - """Sets the datasheet_header of this GsaUpdateTable. - - Parameters - ---------- - datasheet_header: str | None | Unset_Type - The datasheet_header of this GsaUpdateTable. - """ - self._datasheet_header = datasheet_header - - @property - def datasheet_footer(self) -> "str | None | Unset_Type": - """Gets the datasheet_footer of this GsaUpdateTable. - - Returns - ------- - str | None | Unset_Type - The datasheet_footer of this GsaUpdateTable. - """ - return self._datasheet_footer - - @datasheet_footer.setter - def datasheet_footer(self, datasheet_footer: "str | None | Unset_Type") -> None: - """Sets the datasheet_footer of this GsaUpdateTable. - - Parameters - ---------- - datasheet_footer: str | None | Unset_Type - The datasheet_footer of this GsaUpdateTable. - """ - self._datasheet_footer = datasheet_footer - - @property - def table_types(self) -> "list[str] | None | Unset_Type": - """Gets the table_types of this GsaUpdateTable. - If specified any existing table types are replaced. - - Returns - ------- - list[str] | None | Unset_Type - The table_types of this GsaUpdateTable. - """ - return self._table_types - - @table_types.setter - def table_types(self, table_types: "list[str] | None | Unset_Type") -> None: - """Sets the table_types of this GsaUpdateTable. - If specified any existing table types are replaced. - - Parameters - ---------- - table_types: list[str] | None | Unset_Type - The table_types of this GsaUpdateTable. - """ - self._table_types = table_types - - @property - def should_show_version_control_signatures(self) -> "bool | Unset_Type": - """Gets the should_show_version_control_signatures of this GsaUpdateTable. - - Returns - ------- - bool | Unset_Type - The should_show_version_control_signatures of this GsaUpdateTable. - """ - return self._should_show_version_control_signatures - - @should_show_version_control_signatures.setter - def should_show_version_control_signatures( - self, should_show_version_control_signatures: "bool | Unset_Type" - ) -> None: - """Sets the should_show_version_control_signatures of this GsaUpdateTable. - - Parameters - ---------- - should_show_version_control_signatures: bool | Unset_Type - The should_show_version_control_signatures of this GsaUpdateTable. - """ - # Field is not nullable - if should_show_version_control_signatures is None: - raise ValueError( - "Invalid value for 'should_show_version_control_signatures', must not be 'None'" - ) - self._should_show_version_control_signatures = should_show_version_control_signatures - @property def name(self) -> "str | Unset_Type": """Gets the name of this GsaUpdateTable. diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_tabular_attribute.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_tabular_attribute.py index d1d5a405e..fc0fe6ac8 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_tabular_attribute.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_update_tabular_attribute.py @@ -71,7 +71,6 @@ class GsaUpdateTabularAttribute(GsaUpdateAttribute): "axis_name": "GsaUpdateAxisName", "default_threshold_type": "GsaAttributeThresholdType", "display_full_table": "bool", - "display_names": "dict(str, str)", "display_summary_row_inline": "bool", "guid": "str", "help_path": "str", @@ -88,7 +87,6 @@ class GsaUpdateTabularAttribute(GsaUpdateAttribute): "axis_name": "axisName", "default_threshold_type": "defaultThresholdType", "display_full_table": "displayFullTable", - "display_names": "displayNames", "display_summary_row_inline": "displaySummaryRowInline", "guid": "guid", "help_path": "helpPath", @@ -114,7 +112,6 @@ def __init__( axis_name: "GsaUpdateAxisName | Unset_Type" = Unset, default_threshold_type: "GsaAttributeThresholdType | Unset_Type" = Unset, display_full_table: "bool | Unset_Type" = Unset, - display_names: "dict[str, str] | None | Unset_Type" = Unset, display_summary_row_inline: "bool | Unset_Type" = Unset, guid: "str | Unset_Type" = Unset, help_path: "str | None | Unset_Type" = Unset, @@ -133,7 +130,6 @@ def __init__( axis_name: GsaUpdateAxisName, optional default_threshold_type: GsaAttributeThresholdType, optional display_full_table: bool, optional - display_names: dict[str, str] | None, optional display_summary_row_inline: bool, optional guid: str, optional help_path: str | None, optional @@ -148,7 +144,6 @@ def __init__( about_attribute=about_attribute, axis_name=axis_name, default_threshold_type=default_threshold_type, - display_names=display_names, guid=guid, help_path=help_path, is_hidden_from_search_criteria=is_hidden_from_search_criteria, diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_exception.py deleted file mode 100644 index 2b1f21261..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_exception.py +++ /dev/null @@ -1,276 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaUpgradeDatabaseException(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "upgrade_database_failure_reason": "GsaUpgradeDatabaseFailureReason", - "additional_information": "str", - "code": "GsaErrorCode", - "errors": "list[GsaErrorDetail]", - "message": "str", - } - - attribute_map: dict[str, str] = { - "upgrade_database_failure_reason": "upgradeDatabaseFailureReason", - "additional_information": "additionalInformation", - "code": "code", - "errors": "errors", - "message": "message", - } - - subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", - "upgradeDatabaseFailureReason": "GsaUpgradeDatabaseFailureReason", - "errors": "GsaErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - upgrade_database_failure_reason: "GsaUpgradeDatabaseFailureReason", - additional_information: "str | None | Unset_Type" = Unset, - code: "GsaErrorCode | Unset_Type" = Unset, - errors: "list[GsaErrorDetail] | None | Unset_Type" = Unset, - message: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaUpgradeDatabaseException - a model defined in Swagger - - Parameters - ---------- - upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - additional_information: str | None, optional - code: GsaErrorCode, optional - errors: list[GsaErrorDetail] | None, optional - message: str | None, optional - """ - self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset - self._upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - self._additional_information: str | None | Unset_Type = Unset - self._errors: list[GsaErrorDetail] | None | Unset_Type = Unset - - if message is not Unset: - self.message = message - if code is not Unset: - self.code = code - self.upgrade_database_failure_reason = upgrade_database_failure_reason - if additional_information is not Unset: - self.additional_information = additional_information - if errors is not Unset: - self.errors = errors - - @property - def message(self) -> "str | None | Unset_Type": - """Gets the message of this GsaUpgradeDatabaseException. - - Returns - ------- - str | None | Unset_Type - The message of this GsaUpgradeDatabaseException. - """ - return self._message - - @message.setter - def message(self, message: "str | None | Unset_Type") -> None: - """Sets the message of this GsaUpgradeDatabaseException. - - Parameters - ---------- - message: str | None | Unset_Type - The message of this GsaUpgradeDatabaseException. - """ - self._message = message - - @property - def code(self) -> "GsaErrorCode | Unset_Type": - """Gets the code of this GsaUpgradeDatabaseException. - - Returns - ------- - GsaErrorCode | Unset_Type - The code of this GsaUpgradeDatabaseException. - """ - return self._code - - @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: - """Sets the code of this GsaUpgradeDatabaseException. - - Parameters - ---------- - code: GsaErrorCode | Unset_Type - The code of this GsaUpgradeDatabaseException. - """ - # Field is not nullable - if code is None: - raise ValueError("Invalid value for 'code', must not be 'None'") - self._code = code - - @property - def upgrade_database_failure_reason(self) -> "GsaUpgradeDatabaseFailureReason": - """Gets the upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - - Returns - ------- - GsaUpgradeDatabaseFailureReason - The upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - """ - return self._upgrade_database_failure_reason - - @upgrade_database_failure_reason.setter - def upgrade_database_failure_reason( - self, upgrade_database_failure_reason: "GsaUpgradeDatabaseFailureReason" - ) -> None: - """Sets the upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - - Parameters - ---------- - upgrade_database_failure_reason: GsaUpgradeDatabaseFailureReason - The upgrade_database_failure_reason of this GsaUpgradeDatabaseException. - """ - # Field is not nullable - if upgrade_database_failure_reason is None: - raise ValueError( - "Invalid value for 'upgrade_database_failure_reason', must not be 'None'" - ) - # Field is required - if upgrade_database_failure_reason is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError( - "Invalid value for 'upgrade_database_failure_reason', must not be 'Unset'" - ) - self._upgrade_database_failure_reason = upgrade_database_failure_reason - - @property - def additional_information(self) -> "str | None | Unset_Type": - """Gets the additional_information of this GsaUpgradeDatabaseException. - - Returns - ------- - str | None | Unset_Type - The additional_information of this GsaUpgradeDatabaseException. - """ - return self._additional_information - - @additional_information.setter - def additional_information(self, additional_information: "str | None | Unset_Type") -> None: - """Sets the additional_information of this GsaUpgradeDatabaseException. - - Parameters - ---------- - additional_information: str | None | Unset_Type - The additional_information of this GsaUpgradeDatabaseException. - """ - self._additional_information = additional_information - - @property - def errors(self) -> "list[GsaErrorDetail] | None | Unset_Type": - """Gets the errors of this GsaUpgradeDatabaseException. - - Returns - ------- - list[GsaErrorDetail] | None | Unset_Type - The errors of this GsaUpgradeDatabaseException. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaErrorDetail] | None | Unset_Type") -> None: - """Sets the errors of this GsaUpgradeDatabaseException. - - Parameters - ---------- - errors: list[GsaErrorDetail] | None | Unset_Type - The errors of this GsaUpgradeDatabaseException. - """ - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaUpgradeDatabaseException): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_failure_reason.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_failure_reason.py deleted file mode 100644 index 0bbc3f159..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_upgrade_database_failure_reason.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaUpgradeDatabaseFailureReason(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - UNABLETOCONNECT = "unableToConnect" - INSUFFICIENTPERMISSIONS = "insufficientPermissions" - UNKNOWNERROR = "unknownError" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_usage_data_modification_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_usage_data_modification_error_detail.py index 31718a7d5..5c64bd50b 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_usage_data_modification_error_detail.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_usage_data_modification_error_detail.py @@ -88,7 +88,7 @@ class GsaUsageDataModificationErrorDetail(GsaDataModificationErrorDetail): discriminator_value_class_map = { "expression".lower(): "#/components/schemas/GsaExpressionUsageDataModificationErrorDetail", "versionControlledData".lower(): "#/components/schemas/GsaVersionControlledDataUsageDataModificationErrorDetail", - "smartLinkGroup".lower(): "#/components/schemas/GsaSmartLinkGroupUsageDataModificationErrorDetail", + "dynamicLinkGroup".lower(): "#/components/schemas/GsaDynamicLinkGroupUsageDataModificationErrorDetail", "tabularAttribute".lower(): "#/components/schemas/GsaTabularAttributeUsageDataModificationErrorDetail", "xyChartTemplate".lower(): "#/components/schemas/GsaXYChartTemplateUsageDataModificationErrorDetail", "searchMask".lower(): "#/components/schemas/GsaSearchMaskUsageDataModificationErrorDetail", @@ -96,13 +96,6 @@ class GsaUsageDataModificationErrorDetail(GsaDataModificationErrorDetail): "attribute".lower(): "#/components/schemas/GsaAttributeUsageDataModificationErrorDetail", "data".lower(): "#/components/schemas/GsaDataUsageDataModificationErrorDetail", "defaultParameterValue".lower(): "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail", - "functionalDataDefault".lower(): "#/components/schemas/GsaFunctionalDataDefaultUsageDataModificationErrorDetail", - "multiValuedPointData".lower(): "#/components/schemas/GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "tabularColumn".lower(): "#/components/schemas/GsaTabularColumnUsageDataModificationErrorDetail", - "databaseCurrencyUnit".lower(): "#/components/schemas/GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "unit".lower(): "#/components/schemas/GsaUnitUsageDataModificationErrorDetail", - "parameter".lower(): "#/components/schemas/GsaParameterUsageDataModificationErrorDetail", - "constant".lower(): "#/components/schemas/GsaConstantUsageDataModificationErrorDetail", } discriminator: Optional[str] = "referenced_by_type" diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_chart_data.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_user_or_group.py similarity index 65% rename from ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_chart_data.py rename to ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_user_or_group.py index 3b524a584..c11cf7bfa 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_discrete_chart_data.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_user_or_group.py @@ -33,11 +33,6 @@ import re # noqa: F401 from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data import ( # noqa: F401 - GsaChartData, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_chart_data_type import GsaChartDataType - from . import ModelBase, Unset, Unset_Type if TYPE_CHECKING: @@ -47,7 +42,7 @@ from . import * -class GsaDiscreteChartData(GsaChartData): +class GsaUserOrGroup(ModelBase): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -66,19 +61,15 @@ class GsaDiscreteChartData(GsaChartData): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "type": "GsaChartDataType", - "bubble_axis_value": "GsaDataExportRange", + "display_name": "str", + "identifier": "str", "name": "str", - "order": "int", - "record_version_guid": "str", } attribute_map: dict[str, str] = { - "type": "type", - "bubble_axis_value": "bubbleAxisValue", + "display_name": "displayName", + "identifier": "identifier", "name": "name", - "order": "order", - "record_version_guid": "recordVersionGuid", } subtype_mapping: dict[str, str] = {} @@ -88,77 +79,95 @@ class GsaDiscreteChartData(GsaChartData): def __init__( self, *, - type: "GsaChartDataType" = GsaChartDataType.DISCRETE, - bubble_axis_value: "GsaDataExportRange | Unset_Type" = Unset, + display_name: "str | None | Unset_Type" = Unset, + identifier: "str | Unset_Type" = Unset, name: "str | None | Unset_Type" = Unset, - order: "int | Unset_Type" = Unset, - record_version_guid: "str | Unset_Type" = Unset, ) -> None: - """GsaDiscreteChartData - a model defined in Swagger + """GsaUserOrGroup - a model defined in Swagger Parameters ---------- - type: GsaChartDataType - bubble_axis_value: GsaDataExportRange, optional + display_name: str | None, optional + identifier: str, optional name: str | None, optional - order: int, optional - record_version_guid: str, optional """ - super().__init__( - type=type, bubble_axis_value=bubble_axis_value, record_version_guid=record_version_guid - ) - self._order: int | Unset_Type = Unset + self._identifier: str | Unset_Type = Unset + self._display_name: str | None | Unset_Type = Unset self._name: str | None | Unset_Type = Unset - if order is not Unset: - self.order = order + if identifier is not Unset: + self.identifier = identifier + if display_name is not Unset: + self.display_name = display_name if name is not Unset: self.name = name @property - def order(self) -> "int | Unset_Type": - """Gets the order of this GsaDiscreteChartData. + def identifier(self) -> "str | Unset_Type": + """Gets the identifier of this GsaUserOrGroup. Returns ------- - int | Unset_Type - The order of this GsaDiscreteChartData. + str | Unset_Type + The identifier of this GsaUserOrGroup. """ - return self._order + return self._identifier - @order.setter - def order(self, order: "int | Unset_Type") -> None: - """Sets the order of this GsaDiscreteChartData. + @identifier.setter + def identifier(self, identifier: "str | Unset_Type") -> None: + """Sets the identifier of this GsaUserOrGroup. Parameters ---------- - order: int | Unset_Type - The order of this GsaDiscreteChartData. + identifier: str | Unset_Type + The identifier of this GsaUserOrGroup. """ # Field is not nullable - if order is None: - raise ValueError("Invalid value for 'order', must not be 'None'") - self._order = order + if identifier is None: + raise ValueError("Invalid value for 'identifier', must not be 'None'") + self._identifier = identifier + + @property + def display_name(self) -> "str | None | Unset_Type": + """Gets the display_name of this GsaUserOrGroup. + + Returns + ------- + str | None | Unset_Type + The display_name of this GsaUserOrGroup. + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name: "str | None | Unset_Type") -> None: + """Sets the display_name of this GsaUserOrGroup. + + Parameters + ---------- + display_name: str | None | Unset_Type + The display_name of this GsaUserOrGroup. + """ + self._display_name = display_name @property def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaDiscreteChartData. + """Gets the name of this GsaUserOrGroup. Returns ------- str | None | Unset_Type - The name of this GsaDiscreteChartData. + The name of this GsaUserOrGroup. """ return self._name @name.setter def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaDiscreteChartData. + """Sets the name of this GsaUserOrGroup. Parameters ---------- name: str | None | Unset_Type - The name of this GsaDiscreteChartData. + The name of this GsaUserOrGroup. """ self._name = name @@ -184,7 +193,7 @@ def __repr__(self) -> str: def __eq__(self, other: Any) -> bool: """Returns true if both objects are equal""" - if not isinstance(other, GsaDiscreteChartData): + if not isinstance(other, GsaUserOrGroup): return False return self.__dict__ == other.__dict__ diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_request.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_request.py deleted file mode 100644 index b1010fe70..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_request.py +++ /dev/null @@ -1,149 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValidateUnitEquationRequest(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "equation": "str", - } - - attribute_map: dict[str, str] = { - "equation": "equation", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - equation: "str", - ) -> None: - """GsaValidateUnitEquationRequest - a model defined in Swagger - - Parameters - ---------- - equation: str - """ - self._equation: str - - self.equation = equation - - @property - def equation(self) -> "str": - """Gets the equation of this GsaValidateUnitEquationRequest. - The equation to check - - Returns - ------- - str - The equation of this GsaValidateUnitEquationRequest. - """ - return self._equation - - @equation.setter - def equation(self, equation: "str") -> None: - """Sets the equation of this GsaValidateUnitEquationRequest. - The equation to check - - Parameters - ---------- - equation: str - The equation of this GsaValidateUnitEquationRequest. - """ - # Field is not nullable - if equation is None: - raise ValueError("Invalid value for 'equation', must not be 'None'") - # Field is required - if equation is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'equation', must not be 'Unset'") - self._equation = equation - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValidateUnitEquationRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_response.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_response.py deleted file mode 100644 index 82c19c6a9..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_validate_unit_equation_response.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValidateUnitEquationResponse(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "errors": "list[GsaUnitEquationErrorDetail]", - "is_valid": "bool", - } - - attribute_map: dict[str, str] = { - "errors": "errors", - "is_valid": "isValid", - } - - subtype_mapping: dict[str, str] = { - "errors": "GsaUnitEquationErrorDetail", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - errors: "list[GsaUnitEquationErrorDetail]", - is_valid: "bool | Unset_Type" = Unset, - ) -> None: - """GsaValidateUnitEquationResponse - a model defined in Swagger - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] - is_valid: bool, optional - """ - self._is_valid: bool | Unset_Type = Unset - self._errors: list[GsaUnitEquationErrorDetail] - - if is_valid is not Unset: - self.is_valid = is_valid - self.errors = errors - - @property - def is_valid(self) -> "bool | Unset_Type": - """Gets the is_valid of this GsaValidateUnitEquationResponse. - - Returns - ------- - bool | Unset_Type - The is_valid of this GsaValidateUnitEquationResponse. - """ - return self._is_valid - - @is_valid.setter - def is_valid(self, is_valid: "bool | Unset_Type") -> None: - """Sets the is_valid of this GsaValidateUnitEquationResponse. - - Parameters - ---------- - is_valid: bool | Unset_Type - The is_valid of this GsaValidateUnitEquationResponse. - """ - # Field is not nullable - if is_valid is None: - raise ValueError("Invalid value for 'is_valid', must not be 'None'") - self._is_valid = is_valid - - @property - def errors(self) -> "list[GsaUnitEquationErrorDetail]": - """Gets the errors of this GsaValidateUnitEquationResponse. - Details of any errors found in the equation. - - Returns - ------- - list[GsaUnitEquationErrorDetail] - The errors of this GsaValidateUnitEquationResponse. - """ - return self._errors - - @errors.setter - def errors(self, errors: "list[GsaUnitEquationErrorDetail]") -> None: - """Sets the errors of this GsaValidateUnitEquationResponse. - Details of any errors found in the equation. - - Parameters - ---------- - errors: list[GsaUnitEquationErrorDetail] - The errors of this GsaValidateUnitEquationResponse. - """ - # Field is not nullable - if errors is None: - raise ValueError("Invalid value for 'errors', must not be 'None'") - # Field is required - if errors is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'errors', must not be 'Unset'") - self._errors = errors - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValidateUnitEquationResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_value_not_provided_parameter_value_error_detail.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_value_not_provided_parameter_value_error_detail.py deleted file mode 100644 index 7c57e7c27..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_value_not_provided_parameter_value_error_detail.py +++ /dev/null @@ -1,187 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_detail import ( # noqa: F401 - GsaParameterValueErrorDetail, -) -from ansys.grantami.serverapi_openapi.v2026r2.models.gsa_parameter_value_error_reason import ( - GsaParameterValueErrorReason, -) - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaValueNotProvidedParameterValueErrorDetail(GsaParameterValueErrorDetail): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "message": "str", - "reason": "GsaParameterValueErrorReason", - "guid": "str", - "name": "str", - } - - attribute_map: dict[str, str] = { - "message": "message", - "reason": "reason", - "guid": "guid", - "name": "name", - } - - subtype_mapping: dict[str, str] = {} - - discriminator: Optional[str] = None - - def __init__( - self, - *, - message: "str", - reason: "GsaParameterValueErrorReason" = GsaParameterValueErrorReason.VALUENOTPROVIDED, - guid: "str | None | Unset_Type" = Unset, - name: "str | None | Unset_Type" = Unset, - ) -> None: - """GsaValueNotProvidedParameterValueErrorDetail - a model defined in Swagger - - Parameters - ---------- - message: str - reason: GsaParameterValueErrorReason - guid: str | None, optional - name: str | None, optional - """ - super().__init__(message=message, reason=reason) - self._name: str | None | Unset_Type = Unset - self._guid: str | None | Unset_Type = Unset - - if name is not Unset: - self.name = name - if guid is not Unset: - self.guid = guid - - @property - def name(self) -> "str | None | Unset_Type": - """Gets the name of this GsaValueNotProvidedParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The name of this GsaValueNotProvidedParameterValueErrorDetail. - """ - return self._name - - @name.setter - def name(self, name: "str | None | Unset_Type") -> None: - """Sets the name of this GsaValueNotProvidedParameterValueErrorDetail. - - Parameters - ---------- - name: str | None | Unset_Type - The name of this GsaValueNotProvidedParameterValueErrorDetail. - """ - self._name = name - - @property - def guid(self) -> "str | None | Unset_Type": - """Gets the guid of this GsaValueNotProvidedParameterValueErrorDetail. - - Returns - ------- - str | None | Unset_Type - The guid of this GsaValueNotProvidedParameterValueErrorDetail. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str | None | Unset_Type") -> None: - """Sets the guid of this GsaValueNotProvidedParameterValueErrorDetail. - - Parameters - ---------- - guid: str | None | Unset_Type - The guid of this GsaValueNotProvidedParameterValueErrorDetail. - """ - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaValueNotProvidedParameterValueErrorDetail): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_weighting_type.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_weighting_type.py deleted file mode 100644 index f0aec0382..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_weighting_type.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from enum import Enum - - -class GsaWeightingType(Enum): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Allowed Enum values - """ - POS_0 = 0 - POS_1 = 1 - POS_2 = 2 diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_withdraw_record_version_control_exception.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_withdraw_record_version_control_exception.py index d53722a7c..cbb91faa2 100644 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_withdraw_record_version_control_exception.py +++ b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_withdraw_record_version_control_exception.py @@ -61,7 +61,7 @@ class GsaWithdrawRecordVersionControlException(ModelBase): Name of the property used as discriminator for subtypes. """ swagger_types: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "list[GsaVersionControlErrorDetail]", "message": "str", } @@ -73,7 +73,7 @@ class GsaWithdrawRecordVersionControlException(ModelBase): } subtype_mapping: dict[str, str] = { - "code": "GsaErrorCode", + "code": "SystemNetHttpStatusCode", "errors": "GsaVersionControlErrorDetail", } @@ -82,7 +82,7 @@ class GsaWithdrawRecordVersionControlException(ModelBase): def __init__( self, *, - code: "GsaErrorCode | Unset_Type" = Unset, + code: "SystemNetHttpStatusCode | Unset_Type" = Unset, errors: "list[GsaVersionControlErrorDetail] | None | Unset_Type" = Unset, message: "str | None | Unset_Type" = Unset, ) -> None: @@ -90,12 +90,12 @@ def __init__( Parameters ---------- - code: GsaErrorCode, optional + code: SystemNetHttpStatusCode, optional errors: list[GsaVersionControlErrorDetail] | None, optional message: str | None, optional """ self._message: str | None | Unset_Type = Unset - self._code: GsaErrorCode | Unset_Type = Unset + self._code: SystemNetHttpStatusCode | Unset_Type = Unset self._errors: list[GsaVersionControlErrorDetail] | None | Unset_Type = Unset if message is not Unset: @@ -128,23 +128,23 @@ def message(self, message: "str | None | Unset_Type") -> None: self._message = message @property - def code(self) -> "GsaErrorCode | Unset_Type": + def code(self) -> "SystemNetHttpStatusCode | Unset_Type": """Gets the code of this GsaWithdrawRecordVersionControlException. Returns ------- - GsaErrorCode | Unset_Type + SystemNetHttpStatusCode | Unset_Type The code of this GsaWithdrawRecordVersionControlException. """ return self._code @code.setter - def code(self, code: "GsaErrorCode | Unset_Type") -> None: + def code(self, code: "SystemNetHttpStatusCode | Unset_Type") -> None: """Sets the code of this GsaWithdrawRecordVersionControlException. Parameters ---------- - code: GsaErrorCode | Unset_Type + code: SystemNetHttpStatusCode | Unset_Type The code of this GsaWithdrawRecordVersionControlException. """ # Field is not nullable diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_template.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_template.py deleted file mode 100644 index 6d6937286..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_template.py +++ /dev/null @@ -1,374 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYChartTemplate(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "display_names": "dict(str, str)", - "guid": "str", - "name": "str", - "chart_title": "str", - "description": "str", - "table_guid": "str", - "x_axis": "GsaXYTemplateAxis", - "y_axis": "GsaXYTemplateAxis", - } - - attribute_map: dict[str, str] = { - "display_names": "displayNames", - "guid": "guid", - "name": "name", - "chart_title": "chartTitle", - "description": "description", - "table_guid": "tableGuid", - "x_axis": "xAxis", - "y_axis": "yAxis", - } - - subtype_mapping: dict[str, str] = { - "xAxis": "GsaXYTemplateAxis", - "yAxis": "GsaXYTemplateAxis", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - display_names: "dict[str, str]", - guid: "str", - name: "str", - chart_title: "str | None | Unset_Type" = Unset, - description: "str | None | Unset_Type" = Unset, - table_guid: "str | Unset_Type" = Unset, - x_axis: "GsaXYTemplateAxis | Unset_Type" = Unset, - y_axis: "GsaXYTemplateAxis | Unset_Type" = Unset, - ) -> None: - """GsaXYChartTemplate - a model defined in Swagger - - Parameters - ---------- - display_names: dict[str, str] - guid: str - name: str - chart_title: str | None, optional - description: str | None, optional - table_guid: str, optional - x_axis: GsaXYTemplateAxis, optional - y_axis: GsaXYTemplateAxis, optional - """ - self._chart_title: str | None | Unset_Type = Unset - self._description: str | None | Unset_Type = Unset - self._table_guid: str | Unset_Type = Unset - self._x_axis: GsaXYTemplateAxis | Unset_Type = Unset - self._y_axis: GsaXYTemplateAxis | Unset_Type = Unset - self._display_names: dict[str, str] - self._name: str - self._guid: str - - if chart_title is not Unset: - self.chart_title = chart_title - if description is not Unset: - self.description = description - if table_guid is not Unset: - self.table_guid = table_guid - if x_axis is not Unset: - self.x_axis = x_axis - if y_axis is not Unset: - self.y_axis = y_axis - self.display_names = display_names - self.name = name - self.guid = guid - - @property - def chart_title(self) -> "str | None | Unset_Type": - """Gets the chart_title of this GsaXYChartTemplate. - - Returns - ------- - str | None | Unset_Type - The chart_title of this GsaXYChartTemplate. - """ - return self._chart_title - - @chart_title.setter - def chart_title(self, chart_title: "str | None | Unset_Type") -> None: - """Sets the chart_title of this GsaXYChartTemplate. - - Parameters - ---------- - chart_title: str | None | Unset_Type - The chart_title of this GsaXYChartTemplate. - """ - self._chart_title = chart_title - - @property - def description(self) -> "str | None | Unset_Type": - """Gets the description of this GsaXYChartTemplate. - - Returns - ------- - str | None | Unset_Type - The description of this GsaXYChartTemplate. - """ - return self._description - - @description.setter - def description(self, description: "str | None | Unset_Type") -> None: - """Sets the description of this GsaXYChartTemplate. - - Parameters - ---------- - description: str | None | Unset_Type - The description of this GsaXYChartTemplate. - """ - self._description = description - - @property - def table_guid(self) -> "str | Unset_Type": - """Gets the table_guid of this GsaXYChartTemplate. - - Returns - ------- - str | Unset_Type - The table_guid of this GsaXYChartTemplate. - """ - return self._table_guid - - @table_guid.setter - def table_guid(self, table_guid: "str | Unset_Type") -> None: - """Sets the table_guid of this GsaXYChartTemplate. - - Parameters - ---------- - table_guid: str | Unset_Type - The table_guid of this GsaXYChartTemplate. - """ - # Field is not nullable - if table_guid is None: - raise ValueError("Invalid value for 'table_guid', must not be 'None'") - self._table_guid = table_guid - - @property - def x_axis(self) -> "GsaXYTemplateAxis | Unset_Type": - """Gets the x_axis of this GsaXYChartTemplate. - - Returns - ------- - GsaXYTemplateAxis | Unset_Type - The x_axis of this GsaXYChartTemplate. - """ - return self._x_axis - - @x_axis.setter - def x_axis(self, x_axis: "GsaXYTemplateAxis | Unset_Type") -> None: - """Sets the x_axis of this GsaXYChartTemplate. - - Parameters - ---------- - x_axis: GsaXYTemplateAxis | Unset_Type - The x_axis of this GsaXYChartTemplate. - """ - # Field is not nullable - if x_axis is None: - raise ValueError("Invalid value for 'x_axis', must not be 'None'") - self._x_axis = x_axis - - @property - def y_axis(self) -> "GsaXYTemplateAxis | Unset_Type": - """Gets the y_axis of this GsaXYChartTemplate. - - Returns - ------- - GsaXYTemplateAxis | Unset_Type - The y_axis of this GsaXYChartTemplate. - """ - return self._y_axis - - @y_axis.setter - def y_axis(self, y_axis: "GsaXYTemplateAxis | Unset_Type") -> None: - """Sets the y_axis of this GsaXYChartTemplate. - - Parameters - ---------- - y_axis: GsaXYTemplateAxis | Unset_Type - The y_axis of this GsaXYChartTemplate. - """ - # Field is not nullable - if y_axis is None: - raise ValueError("Invalid value for 'y_axis', must not be 'None'") - self._y_axis = y_axis - - @property - def display_names(self) -> "dict[str, str]": - """Gets the display_names of this GsaXYChartTemplate. - A dictionary of the culture name to the name that should be used in that culture for the item - - Returns - ------- - dict[str, str] - The display_names of this GsaXYChartTemplate. - """ - return self._display_names - - @display_names.setter - def display_names(self, display_names: "dict[str, str]") -> None: - """Sets the display_names of this GsaXYChartTemplate. - A dictionary of the culture name to the name that should be used in that culture for the item - - Parameters - ---------- - display_names: dict[str, str] - The display_names of this GsaXYChartTemplate. - """ - # Field is not nullable - if display_names is None: - raise ValueError("Invalid value for 'display_names', must not be 'None'") - # Field is required - if display_names is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'display_names', must not be 'Unset'") - self._display_names = display_names - - @property - def name(self) -> "str": - """Gets the name of this GsaXYChartTemplate. - - Returns - ------- - str - The name of this GsaXYChartTemplate. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaXYChartTemplate. - - Parameters - ---------- - name: str - The name of this GsaXYChartTemplate. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaXYChartTemplate. - - Returns - ------- - str - The guid of this GsaXYChartTemplate. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaXYChartTemplate. - - Parameters - ---------- - guid: str - The guid of this GsaXYChartTemplate. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYChartTemplate): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_templates_info.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_templates_info.py deleted file mode 100644 index 8a685ff62..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_chart_templates_info.py +++ /dev/null @@ -1,219 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYChartTemplatesInfo(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "entries": "list[GsaXYChartTemplate]", - "item_type": "GsaPaginatedItemType", - "links": "GsaPaginationLinks", - } - - attribute_map: dict[str, str] = { - "entries": "entries", - "item_type": "itemType", - "links": "links", - } - - subtype_mapping: dict[str, str] = { - "itemType": "GsaPaginatedItemType", - "entries": "GsaXYChartTemplate", - "links": "GsaPaginationLinks", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - entries: "list[GsaXYChartTemplate]", - item_type: "GsaPaginatedItemType", - links: "GsaPaginationLinks", - ) -> None: - """GsaXYChartTemplatesInfo - a model defined in Swagger - - Parameters - ---------- - entries: list[GsaXYChartTemplate] - item_type: GsaPaginatedItemType - links: GsaPaginationLinks - """ - self._item_type: GsaPaginatedItemType - self._entries: list[GsaXYChartTemplate] - self._links: GsaPaginationLinks - - self.item_type = item_type - self.entries = entries - self.links = links - - @property - def item_type(self) -> "GsaPaginatedItemType": - """Gets the item_type of this GsaXYChartTemplatesInfo. - - Returns - ------- - GsaPaginatedItemType - The item_type of this GsaXYChartTemplatesInfo. - """ - return self._item_type - - @item_type.setter - def item_type(self, item_type: "GsaPaginatedItemType") -> None: - """Sets the item_type of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - item_type: GsaPaginatedItemType - The item_type of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if item_type is None: - raise ValueError("Invalid value for 'item_type', must not be 'None'") - # Field is required - if item_type is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'item_type', must not be 'Unset'") - self._item_type = item_type - - @property - def entries(self) -> "list[GsaXYChartTemplate]": - """Gets the entries of this GsaXYChartTemplatesInfo. - - Returns - ------- - list[GsaXYChartTemplate] - The entries of this GsaXYChartTemplatesInfo. - """ - return self._entries - - @entries.setter - def entries(self, entries: "list[GsaXYChartTemplate]") -> None: - """Sets the entries of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - entries: list[GsaXYChartTemplate] - The entries of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if entries is None: - raise ValueError("Invalid value for 'entries', must not be 'None'") - # Field is required - if entries is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'entries', must not be 'Unset'") - self._entries = entries - - @property - def links(self) -> "GsaPaginationLinks": - """Gets the links of this GsaXYChartTemplatesInfo. - - Returns - ------- - GsaPaginationLinks - The links of this GsaXYChartTemplatesInfo. - """ - return self._links - - @links.setter - def links(self, links: "GsaPaginationLinks") -> None: - """Sets the links of this GsaXYChartTemplatesInfo. - - Parameters - ---------- - links: GsaPaginationLinks - The links of this GsaXYChartTemplatesInfo. - """ - # Field is not nullable - if links is None: - raise ValueError("Invalid value for 'links', must not be 'None'") - # Field is required - if links is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'links', must not be 'Unset'") - self._links = links - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYChartTemplatesInfo): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_template_axis.py b/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_template_axis.py deleted file mode 100644 index 6a3b72614..000000000 --- a/ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/v2026r2/models/gsa_xy_template_axis.py +++ /dev/null @@ -1,344 +0,0 @@ -# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates. -# SPDX-License-Identifier: MIT -# -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -""" -MI Server API - -No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - -OpenAPI spec version: v1 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import re # noqa: F401 -from typing import TYPE_CHECKING, Any, BinaryIO, Optional # noqa: F401 - -from . import ModelBase, Unset, Unset_Type - -if TYPE_CHECKING: - from datetime import datetime - import pathlib - - from . import * - - -class GsaXYTemplateAxis(ModelBase): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes - ---------- - swagger_types: dict[str, str] - The key is attribute name and the value is attribute type. - attribute_map: dict[str, str] - The key is attribute name and the value is json key in definition. - subtype_mapping: dict[str, str] - The key is the unmangled property name and the value is the corresponding type. - discriminator: Optional[str] - Name of the property used as discriminator for subtypes. - """ - swagger_types: dict[str, str] = { - "guid": "str", - "name": "str", - "attribute_guid": "str", - "attribute_unit": "GsaUnit", - "auto_scale": "bool", - "bounds": "GsaDataExportRange", - "logarithmic": "bool", - } - - attribute_map: dict[str, str] = { - "guid": "guid", - "name": "name", - "attribute_guid": "attributeGuid", - "attribute_unit": "attributeUnit", - "auto_scale": "autoScale", - "bounds": "bounds", - "logarithmic": "logarithmic", - } - - subtype_mapping: dict[str, str] = { - "bounds": "GsaDataExportRange", - "attributeUnit": "GsaUnit", - } - - discriminator: Optional[str] = None - - def __init__( - self, - *, - guid: "str", - name: "str", - attribute_guid: "str | Unset_Type" = Unset, - attribute_unit: "GsaUnit | Unset_Type" = Unset, - auto_scale: "bool | Unset_Type" = Unset, - bounds: "GsaDataExportRange | Unset_Type" = Unset, - logarithmic: "bool | Unset_Type" = Unset, - ) -> None: - """GsaXYTemplateAxis - a model defined in Swagger - - Parameters - ---------- - guid: str - name: str - attribute_guid: str, optional - attribute_unit: GsaUnit, optional - auto_scale: bool, optional - bounds: GsaDataExportRange, optional - logarithmic: bool, optional - """ - self._attribute_guid: str | Unset_Type = Unset - self._logarithmic: bool | Unset_Type = Unset - self._bounds: GsaDataExportRange | Unset_Type = Unset - self._attribute_unit: GsaUnit | Unset_Type = Unset - self._auto_scale: bool | Unset_Type = Unset - self._name: str - self._guid: str - - if attribute_guid is not Unset: - self.attribute_guid = attribute_guid - if logarithmic is not Unset: - self.logarithmic = logarithmic - if bounds is not Unset: - self.bounds = bounds - if attribute_unit is not Unset: - self.attribute_unit = attribute_unit - if auto_scale is not Unset: - self.auto_scale = auto_scale - self.name = name - self.guid = guid - - @property - def attribute_guid(self) -> "str | Unset_Type": - """Gets the attribute_guid of this GsaXYTemplateAxis. - - Returns - ------- - str | Unset_Type - The attribute_guid of this GsaXYTemplateAxis. - """ - return self._attribute_guid - - @attribute_guid.setter - def attribute_guid(self, attribute_guid: "str | Unset_Type") -> None: - """Sets the attribute_guid of this GsaXYTemplateAxis. - - Parameters - ---------- - attribute_guid: str | Unset_Type - The attribute_guid of this GsaXYTemplateAxis. - """ - # Field is not nullable - if attribute_guid is None: - raise ValueError("Invalid value for 'attribute_guid', must not be 'None'") - self._attribute_guid = attribute_guid - - @property - def logarithmic(self) -> "bool | Unset_Type": - """Gets the logarithmic of this GsaXYTemplateAxis. - - Returns - ------- - bool | Unset_Type - The logarithmic of this GsaXYTemplateAxis. - """ - return self._logarithmic - - @logarithmic.setter - def logarithmic(self, logarithmic: "bool | Unset_Type") -> None: - """Sets the logarithmic of this GsaXYTemplateAxis. - - Parameters - ---------- - logarithmic: bool | Unset_Type - The logarithmic of this GsaXYTemplateAxis. - """ - # Field is not nullable - if logarithmic is None: - raise ValueError("Invalid value for 'logarithmic', must not be 'None'") - self._logarithmic = logarithmic - - @property - def bounds(self) -> "GsaDataExportRange | Unset_Type": - """Gets the bounds of this GsaXYTemplateAxis. - - Returns - ------- - GsaDataExportRange | Unset_Type - The bounds of this GsaXYTemplateAxis. - """ - return self._bounds - - @bounds.setter - def bounds(self, bounds: "GsaDataExportRange | Unset_Type") -> None: - """Sets the bounds of this GsaXYTemplateAxis. - - Parameters - ---------- - bounds: GsaDataExportRange | Unset_Type - The bounds of this GsaXYTemplateAxis. - """ - # Field is not nullable - if bounds is None: - raise ValueError("Invalid value for 'bounds', must not be 'None'") - self._bounds = bounds - - @property - def attribute_unit(self) -> "GsaUnit | Unset_Type": - """Gets the attribute_unit of this GsaXYTemplateAxis. - - Returns - ------- - GsaUnit | Unset_Type - The attribute_unit of this GsaXYTemplateAxis. - """ - return self._attribute_unit - - @attribute_unit.setter - def attribute_unit(self, attribute_unit: "GsaUnit | Unset_Type") -> None: - """Sets the attribute_unit of this GsaXYTemplateAxis. - - Parameters - ---------- - attribute_unit: GsaUnit | Unset_Type - The attribute_unit of this GsaXYTemplateAxis. - """ - # Field is not nullable - if attribute_unit is None: - raise ValueError("Invalid value for 'attribute_unit', must not be 'None'") - self._attribute_unit = attribute_unit - - @property - def auto_scale(self) -> "bool | Unset_Type": - """Gets the auto_scale of this GsaXYTemplateAxis. - - Returns - ------- - bool | Unset_Type - The auto_scale of this GsaXYTemplateAxis. - """ - return self._auto_scale - - @auto_scale.setter - def auto_scale(self, auto_scale: "bool | Unset_Type") -> None: - """Sets the auto_scale of this GsaXYTemplateAxis. - - Parameters - ---------- - auto_scale: bool | Unset_Type - The auto_scale of this GsaXYTemplateAxis. - """ - # Field is not nullable - if auto_scale is None: - raise ValueError("Invalid value for 'auto_scale', must not be 'None'") - self._auto_scale = auto_scale - - @property - def name(self) -> "str": - """Gets the name of this GsaXYTemplateAxis. - - Returns - ------- - str - The name of this GsaXYTemplateAxis. - """ - return self._name - - @name.setter - def name(self, name: "str") -> None: - """Sets the name of this GsaXYTemplateAxis. - - Parameters - ---------- - name: str - The name of this GsaXYTemplateAxis. - """ - # Field is not nullable - if name is None: - raise ValueError("Invalid value for 'name', must not be 'None'") - # Field is required - if name is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'name', must not be 'Unset'") - self._name = name - - @property - def guid(self) -> "str": - """Gets the guid of this GsaXYTemplateAxis. - - Returns - ------- - str - The guid of this GsaXYTemplateAxis. - """ - return self._guid - - @guid.setter - def guid(self, guid: "str") -> None: - """Sets the guid of this GsaXYTemplateAxis. - - Parameters - ---------- - guid: str - The guid of this GsaXYTemplateAxis. - """ - # Field is not nullable - if guid is None: - raise ValueError("Invalid value for 'guid', must not be 'None'") - # Field is required - if guid is Unset: # type: ignore[comparison-overlap, unused-ignore] - raise ValueError("Invalid value for 'guid', must not be 'Unset'") - self._guid = guid - - @classmethod - def get_real_child_model(cls, data: dict[str, str]) -> str: - """Raises a NotImplementedError for a type without a discriminator defined. - - Parameters - ---------- - data: ModelBase - Object representing a subclass of this class - - Raises - ------ - NotImplementedError - This class has no discriminator, and hence no subclasses - """ - raise NotImplementedError() - - def __repr__(self) -> str: - """For 'print' and 'pprint'""" - return self.to_str() - - def __eq__(self, other: Any) -> bool: - """Returns true if both objects are equal""" - if not isinstance(other, GsaXYTemplateAxis): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other: Any) -> bool: - """Returns true if both objects are not equal""" - return not self == other diff --git a/ansys-grantami-serverapi-openapi/uv.lock b/ansys-grantami-serverapi-openapi/uv.lock index 978af93eb..1caaa2b80 100644 --- a/ansys-grantami-serverapi-openapi/uv.lock +++ b/ansys-grantami-serverapi-openapi/uv.lock @@ -4,7 +4,7 @@ requires-python = ">=3.10" [[package]] name = "ansys-grantami-serverapi-openapi" -version = "5.2.0.dev1077" +version = "5.2.0.dev1079" source = { editable = "." } dependencies = [ { name = "ansys-openapi-common" }, diff --git a/yaml/server-api.json b/yaml/server-api.json index 67c41573e..5a84a4e77 100644 --- a/yaml/server-api.json +++ b/yaml/server-api.json @@ -5,170 +5,53 @@ "version": "v1" }, "paths": { - "/v1alpha/accessControl/currentMode": { - "get": { - "tags": [ - "Access Control" - ], - "summary": "Gets the information about current access control mode.", - "operationId": "GetCurrentAccessControlMode", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlModeInfo" - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/databases/{database-key}/access-control-categories": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": { + "post": { "tags": [ - "Access Control - Attribute-Based Categories" + "Aggregation" ], - "summary": "Get all access control categories for the specified database.", - "operationId": "GetCategories", + "summary": "Runs an aggregation against the table.", + "operationId": "DatabaseAggregationForTableWithIdentity", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "include", - "in": "query", - "description": "Optionally include related data e.g. tableMappings in the response.", + "name": "table-identity", + "in": "path", + "required": true, "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoriesInfo" - }, - "examples": { - "Example 1": { - "summary": "Get all categories", - "description": "An example response for all access control categories without including tableMappings.", - "value": { - "categories": [ - { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" - }, - "name": "Ownership", - "guid": "830376aa-3e23-43c2-8b89-cee806d6c4d0" - }, - { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - ] - } - }, - "Example 2": { - "summary": "Include tableMappings", - "description": "An example response for all access control categories including tableMappings.", - "value": { - "categories": [ - { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" - } - } - ], - "name": "Ownership", - "guid": "830376aa-3e23-43c2-8b89-cee806d6c4d0" - }, - { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - ] - } - } - } - } + "type": "integer", + "format": "int32" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "post": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Create an attribute-based access control category in the specified database.", - "operationId": "CreateCategory", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -176,599 +59,658 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category with name, discrete type, and table mappings", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "innerCriterion": { + "type": "integer" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Ownership" + ] } }, "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category with only name and discrete type, without any table mappings", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category with name, discrete type, and table mappings", + }, + "Example 3": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Ownership" + ] } }, - "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category with only name and discrete type, without any table mappings", + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "criterionGuid": "1a0b0d32-ae6f-4511-acdc-49ee87f97242", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category with name, discrete type, and table mappings", + }, + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "38858cdb-7745-4ff1-b0f5-29ab0a0fcd1f", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "localColumns": { + "filterOn": "none" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "type": "text" } - ], - "name": "Ownership" + ] } }, - "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category with only name and discrete type, without any table mappings", + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "e9913483-8bc8-4aa1-a2fd-98c532b6f988", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Create a new access control category", - "description": "Create a new access control category with name, discrete type, and table mappings", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "discreteType": { - "guid": "39e584e4-b9df-41e1-859f-3464c10e28cc" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "tableMappings": [ + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "8d709b2b-cb4c-4a56-9160-7b487338b6de" + "innerCriterion": { + "type": "integer" }, - "tableDiscreteValues": [ - { - "guid": "1bf8f597-9d0e-4658-a95a-3b7d482bef98" - } - ] + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Ownership" + ] } }, "Example 2": { - "summary": "Create without table mappings", - "description": "Create a new access control category with only name and discrete type, without any table mappings", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - "name": "Status" + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" }, - "examples": { - "Example 3": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 4": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } + "Example 3": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoryCreationException" }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with name 'Ownership', but an access control category with that name already exists.", - "value": { - "message": "Cannot create access control category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "AccessControlCategory with name 'Ownership' already exists in this Database.", - "name": "Ownership", - "parentEntityType": "database", - "reason": "nameAlreadyExists", - "entityType": "accessControlCategory" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "No such discrete type", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a discrete type GUID that could not be found.", - "value": { - "message": "Cannot create access control category 'Status'.", - "code": "accessControlCategoryCreation", - "name": "Status", - "errors": [ - { - "message": "Could not find discrete type with GUID 'd7d18a5a-ff91-4858-ad22-ca8d650ee609'.", - "guid": "d7d18a5a-ff91-4858-ad22-ca8d650ee609", - "entityType": "discreteType", - "reason": "noSuchEntity" - } - ] - } - }, - "Example 3": { - "summary": "No such table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a table mapping containing a table GUID that could not be found.", - "value": { - "message": "Cannot create access control category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "Could not find table with GUID '2703002b-965b-4d00-9f03-0b69f7d1c84e'.", - "guid": "2703002b-965b-4d00-9f03-0b69f7d1c84e", - "entityType": "table", - "reason": "noSuchEntity" - } - ] - } - }, - "Example 4": { - "summary": "Attribute not on table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an access control category with a table mapping where the attribute does not belong to the specified table.", - "value": { - "message": "Cannot create access control category 'Ownership'.", - "code": "accessControlCategoryCreation", - "name": "Ownership", - "errors": [ - { - "message": "The attribute GUID '3e4f10aa-110f-41ad-9b47-c21725d52004' does not belong to table '631d826f-c5a2-4556-8479-cc21d09f4b50'.", - "attributeGuid": "3e4f10aa-110f-41ad-9b47-c21725d52004", - "tableGuid": "631d826f-c5a2-4556-8479-cc21d09f4b50", - "reason": "attributeNotOnTable" - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateAttributeBasedCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/access-control-categories/{category-guid}": { - "get": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Get the access control category with the specified guid in the specified database.", - "operationId": "GetCategoryByGuid", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "include", - "in": "query", - "description": "Optionally include related data e.g. tableMappings in the response.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryInclude" - } - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" }, - "examples": { - "Example 1": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 2": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Access Control - Attribute-Based Categories" - ], - "summary": "Update an attribute-based access control category in the specified database.", - "operationId": "UpdateCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "name": "Ownership (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "1a0b0d32-ae6f-4511-acdc-49ee87f97242", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Update table mappings", - "description": "This example demonstrates how to update the table mappings for an access control category.", + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "38858cdb-7745-4ff1-b0f5-29ab0a0fcd1f", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update table mappings with default values", - "description": "This example demonstrates how to update table mappings including default discrete values.", + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "e9913483-8bc8-4aa1-a2fd-98c532b6f988", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "type": "text" + } + ] + } + }, + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "Ownership (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, "Example 2": { - "summary": "Update table mappings", - "description": "This example demonstrates how to update the table mappings for an access control category.", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "type": "integer" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, "Example 3": { - "summary": "Update table mappings with default values", - "description": "This example demonstrates how to update table mappings including default discrete values.", + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", + }, + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "name": "Ownership (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "1a0b0d32-ae6f-4511-acdc-49ee87f97242", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Update table mappings", - "description": "This example demonstrates how to update the table mappings for an access control category.", + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "38858cdb-7745-4ff1-b0f5-29ab0a0fcd1f", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update table mappings with default values", - "description": "This example demonstrates how to update table mappings including default discrete values.", + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "criterionGuid": "e9913483-8bc8-4aa1-a2fd-98c532b6f988", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "type": "text" + } + ] + } + }, + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -777,349 +719,300 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of an access control category.", + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "Ownership (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, "Example 2": { - "summary": "Update table mappings", - "description": "This example demonstrates how to update the table mappings for an access control category.", + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "type": "integer" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, "Example 3": { - "summary": "Update table mappings with default values", - "description": "This example demonstrates how to update table mappings including default discrete values.", + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "tableMappings": [ + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 4": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" }, - "tableDiscreteValues": [ - { - "guid": "864da6dd-529f-4643-9d98-e14dc7f83479" - } - ] + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategory" }, - "examples": { - "Example 7": { - "summary": "Get a single category", - "description": "An example response for a single access control category without including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" - }, - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } - }, - "Example 8": { - "summary": "Include tableMappings", - "description": "An example response for a single access control category including tableMappings.", - "value": { - "discreteType": { - "guid": "683db97e-b985-42a2-9dd8-4b77f48b1855" + "Example 5": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "1a0b0d32-ae6f-4511-acdc-49ee87f97242", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] + } + }, + "Example 6": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "38858cdb-7745-4ff1-b0f5-29ab0a0fcd1f", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 7": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "e9913483-8bc8-4aa1-a2fd-98c532b6f988", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 8": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" }, - "tableMappings": [ - { - "table": { - "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - }, - "attribute": { - "guid": "201102ca-801f-4b29-b1ed-cb7ad22ffea1" - } - } - ], - "name": "Status", - "guid": "21c02733-3606-40a3-9d03-ceb05b1fb271" - } + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } } - }, - "400": { - "description": "Bad request", + } + }, + "responses": { + "200": { + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAccessControlCategoryUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a name that already exists.", - "value": { - "message": "Cannot update access control category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "AccessControlCategory with name 'Status' already exists in this Database.", - "name": "Status", - "parentEntityType": "database", - "reason": "nameAlreadyExists", - "entityType": "accessControlCategory" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "No such table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a table mapping containing a table GUID that could not be found.", - "value": { - "message": "Cannot update access control category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "Could not find table with GUID '22608a00-d1a6-4da5-ab0a-866cdb248ae9'.", - "guid": "22608a00-d1a6-4da5-ab0a-866cdb248ae9", - "entityType": "table", - "reason": "noSuchEntity" - } - ] - } - }, - "Example 3": { - "summary": "Attribute not on table", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with a table mapping where the attribute does not belong to the specified table.", - "value": { - "message": "Cannot update access control category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The attribute GUID '31eca429-b0b3-4a2a-942e-3b1aec8eb3c1' does not belong to table '9f9e3282-8ce3-4e96-8331-c90234dea219'.", - "attributeGuid": "31eca429-b0b3-4a2a-942e-3b1aec8eb3c1", - "tableGuid": "9f9e3282-8ce3-4e96-8331-c90234dea219", - "reason": "attributeNotOnTable" - } - ] - } - }, - "Example 4": { - "summary": "Attribute discrete type mismatch", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update an access control category with an attribute that uses a different discrete type.", - "value": { - "message": "Cannot update access control category with GUID '830376aa-3e23-43c2-8b89-cee806d6c4d0'.", - "code": "accessControlCategoryUpdate", - "categoryGuid": "830376aa-3e23-43c2-8b89-cee806d6c4d0", - "errors": [ - { - "message": "The attribute GUID '8a546793-c57a-49fe-97ba-66c5f95f967a' uses discrete type '3c8483b3-da58-48d5-b46a-b31f5f800242' but expected 'd3ed847b-2fc8-4e12-bae5-8c32b8e63c67'.", - "attributeGuid": "8a546793-c57a-49fe-97ba-66c5f95f967a", - "expectedDiscreteTypeGuid": "d3ed847b-2fc8-4e12-bae5-8c32b8e63c67", - "actualDiscreteTypeGuid": "3c8483b3-da58-48d5-b46a-b31f5f800242", - "reason": "attributeDiscreteTypeMismatch" - } - ] - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" + "description": "Database or table not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": { + "post": { "tags": [ - "Access Control - Attribute-Based Categories" + "Aggregation" ], - "summary": "Delete an attribute-based access control category in the specified database.", - "operationId": "DeleteCategory", + "summary": "Runs an aggregation against the table.", + "operationId": "DatabaseAggregationForTableWithGuid", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "category-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get all permission-based access control categories for the specified database.", - "operationId": "GetPermissionCategories", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" - }, - "example": { - "categories": [ - { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - { - "permissions": [ - { - "role": "DOMAIN\\Public", - "name": "Public", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - { - "role": "DOMAIN\\Internal", - "name": "Internal", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - } - ], - "name": "Sensitivity", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - } - ] - } - } + "enum": [ + "read", + "write" + ], + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "post": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Create a new permission-based access control category.", - "operationId": "CreatePermissionCategory", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -1127,428 +1020,218 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + }, + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + }, + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission category", - "description": "Create a new permission category with name and permissions", + }, + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } - ], - "name": "Division" + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryCreationException" + "aggregationCriteria": [ + { + "criterionGuid": "1addb7b3-eb02-4c00-82ea-358c236267f6", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] + } }, - "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with name 'Geo', but a permission category with that name already exists.", - "value": { - "message": "Cannot create permission category 'Geo'.", - "code": "permissionCategoryCreation", - "name": "Geo", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "PermissionCategory with name 'Geo' already exists in this Database.", - "name": "Geo", - "parentEntityType": "database", - "reason": "nameAlreadyExists", - "entityType": "permissionCategory" - } + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "b4de17b6-2019-418e-8812-9a12a36cb874", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "No permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category without providing any permissions. PermissionCategories must always have at least one permission.", - "value": { - "message": "Cannot create permission category 'Division'.", - "code": "permissionCategoryCreation", - "name": "Division", - "errors": [ - { - "message": "Permission categories must have at least one permission.", - "reason": "noPermissions" - } - ] - } - }, - "Example 3": { - "summary": "Invalid permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with a permission 'Design', but the 'Design' permission did not have a role.", - "value": { - "message": "Cannot create permission category 'Division'.", - "code": "permissionCategoryCreation", - "name": "Division", - "errors": [ - { - "message": "The permission 'Design' is not valid.", - "name": "Design", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ], - "reason": "permission" - } - ] - } - }, - "Example 4": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission category with 5 new permissions, but this would exceed the maximum number of permissions available in the database schema.", - "value": { - "message": "Cannot create permission category 'Design'.", - "code": "permissionCategoryCreation", - "name": "Design", - "errors": [ - { - "message": "The 5 new permissions cannot be added, there are not enough permissions available.", - "numberOfNewPermissions": 5, - "maxNumberOfPermissions": 128, - "reason": "tooManyPermissions" - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreatePermissionCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "put": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Replace all permission-based access control categories.\r\nThis can result in adding, modifying and deleting permission categories.", - "operationId": "ReplacePermissionCategories", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" - }, - "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", - "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, - { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", - "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "criterionGuid": "bdc94a34-95fb-4617-a8e7-6646a6221470", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } @@ -1557,1155 +1240,731 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" - }, - "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + }, + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "criterionGuid": "1addb7b3-eb02-4c00-82ea-358c236267f6", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "criterionGuid": "b4de17b6-2019-418e-8812-9a12a36cb874", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] + "criterionGuid": "bdc94a34-95fb-4617-a8e7-6646a6221470", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" } ] } }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoriesRequest" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create new Permission Categories", - "description": "This example demonstrates how to create new Permission Categories. Any existing Permission Categories will be deleted.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "create", - "name": "Security", - "permissions": [ - { - "role": "DOMAIN\\High Security", - "name": "High" - }, - { - "role": "DOMAIN\\Low Security", - "name": "Low" - } - ] + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" } ] } }, - "Example 2": { - "summary": "Reorder Permission Categories", - "description": "This example demonstrates how to reorder Permission Categories. Each category must be included with a matching GUID. Any missing categories will be deleted.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "categories": [ - { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } }, - "Example 3": { - "summary": "Update Permissions on Permission Categories", - "description": "This example demonstrates how to update Permission Categories. It updates the role on each Permission on each Category.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "categories": [ - { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "permissions": [ - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "role": "New Domain\\US" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "role": "New Domain\\EMEA" - }, - { - "type": "update", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a", - "role": "New Domain\\APAC" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6", - "permissions": [ - { - "type": "update", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe", - "role": "New Domain\\Public" - }, - { - "type": "update", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa", - "role": "New Domain\\Internal" - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Update several Permission Categories", - "description": "This example demonstrates how to make several updates to PermissionCategories. The 'Sensitivity' category is not included, so will be deleted. A new category 'Division' is inserted as the first category. The Geo category has several updates: It is renamed, and its permissions are updated as follows: add a new permission 'LATAM', rename the existing 'EMEA' permission, and delete the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "categories": [ - { - "type": "create", - "name": "Division", - "permissions": [ - { - "role": "DOMAIN\\Design", - "name": "Design" - }, - { - "role": "DOMAIN\\Materials", - "description": "Members of the Materials role", - "setMessage": "Materials permission granted", - "unsetMessage": "Materials permission not granted", - "name": "Materials" - } - ] - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "name": "Geo (renamed)", - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, - { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - ] + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" }, - "example": { - "categories": [ - { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "permissions": [ - { - "role": "DOMAIN\\Public", - "name": "Public", - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "aggregationCriteria": [ + { + "criterionGuid": "1addb7b3-eb02-4c00-82ea-358c236267f6", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" }, - { - "role": "DOMAIN\\Internal", - "name": "Internal", - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - } - ], - "name": "Sensitivity", - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryReplaceException" + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] + } }, - "examples": { - "Example 1": { - "summary": "Permission Category to Update not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, but two of the permission categories to be updated could not be found.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The following GUIDs do not correspond to existing categories: '42d3a116-4e96-4e58-a4b9-fd768dbfc7bc', 'a6a4dc2a-d077-4b52-96f3-defb55d42a37'.", - "missingGuids": [ - "42d3a116-4e96-4e58-a4b9-fd768dbfc7bc", - "a6a4dc2a-d077-4b52-96f3-defb55d42a37" - ], - "reason": "noSuchCategories" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate Permission Categories", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, but the replacement would result in two permission categories with the same name 'Division'.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "Duplicate categories were specified. Duplicate names: 'Division'; Duplicate GUIDs: ''.", - "duplicateNames": [ - "Division" - ], - "duplicateGuids": [], - "reason": "duplicateCategories" - } - ] - } - }, - "Example 3": { - "summary": "Invalid permissions provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, and insert a new permission category 'Division' with a permission 'Design', but the 'Design' permission did not have a role.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The category 'Division' is not valid.", - "name": "Division", - "errors": [ - { - "message": "The permission 'Design' is not valid.", - "name": "Design", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ], - "reason": "permission" - } + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "b4de17b6-2019-418e-8812-9a12a36cb874", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 ], - "reason": "category" - } - ] - } - }, - "Example 4": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to replace the permission categories, and insert 5 new permission categories, either by creating new categories or adding permissions to existing categories, but this would exceed the maximum number of permissions available in the database schema.", - "value": { - "message": "Cannot replace permission categories.", - "code": "permissionCategoryReplace", - "errors": [ - { - "message": "The 5 new permissions cannot be added, there are not enough permissions available.", - "numberOfNewPermissions": 5, - "maxNumberOfPermissions": 128, - "reason": "tooManyPermissions" - } - ] - } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The required property 'categories' was not provided.", - "value": { - "message": "ReplacePermissionCategoriesRequest: Required property 'categories' not found in JSON", - "code": "jsonSerialization" - } - }, - "Example 6": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided on a category.", - "value": { - "message": "CreatePutPermissionCategory: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get a permission-based access control category with a specified guid.", - "operationId": "GetPermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Update a permission-based access control category.", - "operationId": "UpdatePermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "name": "Geo (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "bdc94a34-95fb-4617-a8e7-6646a6221470", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" + "criterion": { + "innerCriterion": { + "type": "dateTime" }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", + "Example 9": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "Geo (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 10": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", - "value": { - "name": "Geo (Updated)" - } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 11": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" } ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategory" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'Geo' permission category.", + }, + "Example 12": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "name": "Geo (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Update permissions", - "description": "This example demonstrates how to update only the 'Permissions' property of the 'Geo' permission category. It adds a new permission 'LATAM', renames the existing 'EMEA' permission, and deletes the 'APAC' permission by not including it. The permissions are reordered following the order of the permissions: 'LATAM', 'EMEA (updated)', 'US'.", + "Example 13": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "permissions": [ - { - "type": "create", - "name": "LATAM", - "role": "DOMAIN\\LATAM" - }, - { - "type": "update", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79", - "name": "EMEA (updated)" - }, + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ { - "type": "update", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "criterionGuid": "1addb7b3-eb02-4c00-82ea-358c236267f6", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" } ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategory" }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "Example 14": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ], - "name": "Geo", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Duplicate permission category name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but a permission category with the new name already exists.", - "value": { - "message": "Cannot update permission category 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "code": "permissionCategoryUpdate", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "PermissionCategory with name 'Sensitivity' already exists in this Database.", - "name": "Sensitivity", - "parentEntityType": "database", - "reason": "nameAlreadyExists", - "entityType": "permissionCategory" - } + "aggregationCriteria": [ + { + "criterionGuid": "b4de17b6-2019-418e-8812-9a12a36cb874", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Permission role not provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', and add a new permission 'LATAM' but the role was empty.", - "value": { - "message": "Cannot update permission category 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "code": "permissionCategoryUpdate", - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "errors": [ - { - "message": "The permission 'LATAM' is not valid.", - "name": "LATAM", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 15": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "bdc94a34-95fb-4617-a8e7-6646a6221470", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" ], - "reason": "permission" - } - ] - } + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 16": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Delete a permission-based access control category.", - "operationId": "DeletePermissionCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get all permission-based access control permissions for the specified category.", - "operationId": "GetPermissionsInCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } } - ], + }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionsInfo" - }, - "example": { - "permissions": [ - { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - { - "role": "DOMAIN\\EMEA", - "description": "Members of the EMEA role", - "name": "EMEA", - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - { - "role": "DOMAIN\\APAC", - "description": "Members of the APAC role", - "name": "APAC", - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - } - ] + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}:aggregations": { "post": { "tags": [ - "Access Control - Permission-Based Schema" + "Aggregation" ], - "summary": "Create a new permission-based access control permission.", - "operationId": "CreatePermission", + "summary": "Runs an aggregation against the database.", + "operationId": "DatabaseAggregation", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -2713,1768 +1972,1502 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] + } + }, + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "2a70c330-3716-42a7-9d22-2cd312adcff2" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + }, + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "2a70c330-3716-42a7-9d22-2cd312adcff2" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "343de7ea-2787-4200-910c-9f92bf5d8a64", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" - }, - "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + }, + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "149cd6d4-b1c7-4526-a022-f4322efc23eb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "65791559-2264-4756-b4a9-746e909f2cc0", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "2a70c330-3716-42a7-9d22-2cd312adcff2" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Create a new permission", - "description": "Create a new permission with name and role", + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "role": "DOMAIN\\LATAM", - "name": "LATAM" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Create a new permission with all properties set", - "description": "Create a new permission with all properties set", + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "role": "DOMAIN\\LATAM", - "description": "Members of the LATAM role", - "setMessage": "LATAM permission granted", - "unsetMessage": "LATAM permission not granted", - "name": "LATAM", - "guid": "2a70c330-3716-42a7-9d22-2cd312adcff2" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" - }, - "example": { - "role": "DOMAIN\\LATAM", - "name": "LATAM", - "guid": "81fdbb32-21af-46b0-8d50-ef26e8bfa037" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCreationException" }, - "examples": { - "Example 1": { - "summary": "Name already exists and role was empty", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission with name 'US', but the role was not provided, and a permission with that name already exists in the category.", - "value": { - "message": "Cannot create permission 'US'.", - "code": "permissionCreation", - "name": "US", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Permission with name 'US' already exists in this PermissionCategory.", - "name": "US", - "parentEntityType": "permissionCategory", - "reason": "nameAlreadyExists", - "entityType": "permission" - } - ], - "reason": "namedEntity" + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" }, - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - }, - "Example 2": { - "summary": "Maximum permissions reached", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a permission, but the maximum number of permissions has already been reached in the database schema.", - "value": { - "message": "Cannot create permission 'LATAM'.", - "code": "permissionCreation", - "name": "LATAM", - "errors": [ - { - "message": "There are no more permissions available, the maximum number 128 has been reached.", - "maxNumberOfPermissions": 128, - "reason": "maxPermissionsReached" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreatePermission: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or category not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}": { - "get": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Get a permission-based access control permission with a given guid in the specified category.", - "operationId": "GetPermissionInCategory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" }, - "example": { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, category or permission not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Update a permission-based access control permission.", - "operationId": "UpdatePermission", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "343de7ea-2787-4200-910c-9f92bf5d8a64", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", - "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "51971f1b-5541-4284-8db8-4993ec204f58" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "149cd6d4-b1c7-4526-a022-f4322efc23eb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "65791559-2264-4756-b4a9-746e909f2cc0", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "51971f1b-5541-4284-8db8-4993ec204f58" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "51971f1b-5541-4284-8db8-4993ec204f58" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermission" - }, - "examples": { - "Example 1": { - "summary": "Update name only", - "description": "This example demonstrates how to update only the 'Name' property of the 'US' permission.", + }, + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "name": "US (Updated)" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Remove SetMessage and UnsetMessage", - "description": "This example demonstrates how to remove the 'SetMessage' and 'UnsetMessage' properties of the 'US' permission by setting them to null.", + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "setMessage": null, - "unsetMessage": null + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "343de7ea-2787-4200-910c-9f92bf5d8a64", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 3": { - "summary": "Update all properties", - "description": "This example demonstrates how to update all properties of the 'US' permission.", + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "role": "DOMAIN\\US_UPDATED", - "description": "Updated members of the US role", - "setMessage": "Updated US permission set", - "unsetMessage": "Updated US permission not set", - "name": "US (Fully Updated)", - "guid": "51971f1b-5541-4284-8db8-4993ec204f58" + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "149cd6d4-b1c7-4526-a022-f4322efc23eb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermission" - }, - "example": { - "role": "DOMAIN\\US", - "description": "Members of the US role", - "setMessage": "Permission set", - "unsetMessage": "No permission set", - "name": "US (Updated)", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionUpdateException" }, - "examples": { - "Example 1": { - "summary": "Duplicate permission name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but a permission with the new name already exists in the category.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Permission with name 'EMEA' already exists in this PermissionCategory.", - "name": "EMEA", - "parentEntityType": "permissionCategory", - "reason": "nameAlreadyExists", - "entityType": "permission" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Role not provided", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but the role was set to an empty string. A role must be provided and cannot be empty or whitespace.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } - }, - "Example 3": { - "summary": "Multiple validation errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7'. The role was not provided and the name already exists in the category.", - "value": { - "message": "Cannot update permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionUpdate", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Permission with name 'EMEA' already exists in this PermissionCategory.", - "name": "EMEA", - "parentEntityType": "permissionCategory", - "reason": "nameAlreadyExists", - "entityType": "permission" - } + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "65791559-2264-4756-b4a9-746e909f2cc0", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" ], - "reason": "namedEntity" + "filterOn": "exclude" }, - { - "message": "Role must be provided, and cannot be empty or whitespace.", - "reason": "roleNotProvided" - } - ] - } + "type": "text" + } + ] + } + }, + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsRequest" + }, + "examples": { + "Example 17": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] + } + }, + "Example 18": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 19": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 20": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] + } + }, + "Example 21": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "343de7ea-2787-4200-910c-9f92bf5d8a64", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] + } + }, + "Example 22": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "149cd6d4-b1c7-4526-a022-f4322efc23eb", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] + } + }, + "Example 23": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "value": { + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "65791559-2264-4756-b4a9-746e909f2cc0", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] + } + }, + "Example 24": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", + "value": { + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, category or permission not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Access Control - Permission-Based Schema" - ], - "summary": "Delete a permission-based access control permission.", - "operationId": "DeletePermission", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "category-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionCategories](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionCategories)", - "format": "uuid" - } - }, - { - "name": "permission-guid", - "in": "path", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "required": true, - "schema": { - "type": "string", - "description": "See [Access Control - Permission-Based Schema/GetPermissionsInCategory](#/Access%20Control%20-%20Permission-Based%20Schema/GetPermissionsInCategory)", - "format": "uuid" } } - ], + }, "responses": { - "400": { - "description": "Bad Request", + "200": { + "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Category must have permissions", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7', but there were no more permissions in that category, and a category must have at least one permission.", - "value": { - "message": "Cannot delete permission '41a93859-0de1-46dc-9dea-0fb464be83a7'.", - "code": "permissionDeletion", - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7", - "errors": [ - { - "message": "Permission categories must have at least one permission.", - "reason": "categoryMustHavePermissions" - } - ] - } - } + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" } } } }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or category or permission not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database not found" } } } }, - "/v1alpha/activity-log/entries": { + "/v1alpha/integration-schemas/{schema}:aggregations": { "post": { "tags": [ - "ActivityLog" + "Aggregation" ], - "summary": "Get filtered activity log entries, ordered from newest to oldest.", - "operationId": "GetEntries", + "summary": "Runs an aggregation against the integration schema.", + "operationId": "IntegrationAggregation", "parameters": [ { - "name": "pageSize", - "in": "query", - "description": "Page size. Defaults to 1 000. The limit is 10 000.", - "schema": { - "type": "integer", - "format": "int32", - "default": 1000 - } - }, - { - "name": "page", - "in": "query", - "description": "Page number. Defaults to 1.", + "name": "schema", + "in": "path", + "required": true, "schema": { - "type": "integer", - "format": "int32", - "default": 1 + "type": "string" } } ], "requestBody": { - "description": "Filter object used to narrow down the entries to return.", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": false - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "a4914abc-c13f-4386-b30d-f45cedd9f365", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "ed923ec8-05bd-49eb-b937-6777e8e1b9b5", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "19238d22-e8af-4921-b55e-31be9523da51", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } - } - }, - "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "a4914abc-c13f-4386-b30d-f45cedd9f365", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "ed923ec8-05bd-49eb-b937-6777e8e1b9b5", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "identities": [ + -4, + -7, + 10907 + ], + "guids": [], + "filterOn": "specific" + }, + "localColumns": { + "filterOn": "none" + }, + "type": "text" + } + ] } }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", + "Example 31": { + "summary": "Free text aggregation with excluded tabular columns", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "19238d22-e8af-4921-b55e-31be9523da51", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "none" + }, + "localColumns": { + "excludedIdentities": [], + "excludedGuids": [ + "d5c215fe-6305-407b-a830-cc5ff14e4cf9", + "bfb3edea-be3e-4598-a711-6abb171a4569" + ], + "filterOn": "exclude" + }, + "type": "text" + } + ] } }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", + "Example 32": { + "summary": "Aggregation with query", + "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" + "criterion": { + "innerCriterion": { + "type": "dateTime" + }, + "identity": 5872, + "isMetaAttribute": false, + "attributeCriterionType": "exists", + "type": "attribute" }, - "usageModeFilter": { - "usageModeToMatch": "view" - } + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "discreteText" + }, + "identity": 5876, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" + "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } - } - }, - "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 25": { + "summary": "Attribute exists aggregation", + "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "exists", + "type": "attribute" + } + ] } }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 26": { + "summary": "Numeric attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "type": "integer" + }, + "identity": 8965, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", + "Example 27": { + "summary": "Text attribute value aggregation", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", + "Example 28": { + "summary": "Text attribute value aggregation with prefix", + "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "innerCriterion": { + "numberOfTerms": 10, + "prefix": "st", + "type": "shortText" + }, + "identity": 10907, + "isMetaAttribute": false, + "attributeAggregationCriterionType": "value", + "type": "attribute" + } + ] } }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", + "Example 29": { + "summary": "Free text aggregation", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } + "criterion": { + "all": [], + "any": [], + "none": [], + "type": "boolean" + }, + "aggregationCriteria": [ + { + "criterionGuid": "a4914abc-c13f-4386-b30d-f45cedd9f365", + "numberOfTerms": 10, + "prefix": "st", + "attributes": { + "filterOn": "all" + }, + "localColumns": { + "filterOn": "all" + }, + "type": "text" + } + ] } }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesFilter" - }, - "examples": { - "Example 1": { - "summary": "Get activity log entries after a specific date", - "description": "Get activity log entries after a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": false, - "dateToInclusive": false - } - } - }, - "Example 2": { - "summary": "Get activity log entries after or on a specific date", - "description": "Get activity log entries after or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - } - } - }, - "Example 3": { - "summary": "Get activity log entries before a specific date", - "description": "Get activity log entries before a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": false - } - } - }, - "Example 4": { - "summary": "Get activity log entries before or on a specific date", - "description": "Get activity log entries before or on a specific date. Inclusive flag defaults to false. If date filter is specified either from or to date must be set.", - "value": { - "dateFilter": { - "dateFromInclusive": false, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 5": { - "summary": "Get activity log entries between specific dates", - "description": "Get activity log entries between specific dates. Inclusive flag defaults to false. If both dates are specified, 'to date' must be later than 'from date'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateTo": "2026-03-29T00:00:00Z", - "dateToInclusive": true - } - } - }, - "Example 6": { - "summary": "Get activity log entries where username is the exact match (case-insensitive)", - "description": "Get activity log entries where username is the exact match (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "mi_user", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 7": { - "summary": "Get activity log entries where username contains the specified value (case-insensitive)", - "description": "Get activity log entries where username contains the specified value (case-insensitive). If username filter is specified, `usernameToMatch` must be set. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 8": { - "summary": "Get activity log entries where application names match the specified list", - "description": "Get activity log entries where application names match the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionExactMatch" - } - } - }, - "Example 9": { - "summary": "Get activity log entries where application names include those from the specified list", - "description": "Get activity log entries where application names include those from the specified list. If application names collection filter is specified `applicationNamesToMatch` must be set. Elements in the list are compared case-insensitive and require an exact match. `collectionMatchType` defaults to `collectionExactMatch`.", - "value": { - "applicationNamesCollectionFilter": { - "applicationNamesToMatch": [ - "MI Explore", - "Server API" - ], - "collectionMatchType": "collectionContains" - } - } - }, - "Example 10": { - "summary": "Get activity log entries where at least one of the application names matches the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names matches the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 11": { - "summary": "Get activity log entries where at least one of the application names contains the specified value (case-insensitive)", - "description": "Get activity log entries where at least one of the application names contains the specified value. If application name filter is specified `applicationNameToMatch` must be set. Value is compared case-insensitive. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "applicationNameFilter": { - "applicationNameToMatch": "MI", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 12": { - "summary": "Get activity log entries where database key matches specified value (case-insensitive)", - "description": "Get activity log entries where database key matches specified value (case-insensitive). If database key filter is specified `databaseKeyToMatch` must be set, but can be null to match entries without database value. `matchType` defaults to `exactMatchCaseInsensitive`.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - } - } - }, - "Example 13": { - "summary": "Get activity log entries where database key contains specified value (case-insensitive)", - "description": "Get activity log entries where database key contains specified value (case-insensitive). For this request `databaseKeyToMatch` must be set and CANNOT be null.", - "value": { - "databaseKeyFilter": { - "databaseKeyToMatch": "training", - "matchType": "containsCaseInsensitive" - } - } - }, - "Example 14": { - "summary": "Get activity log entries where usage mode is equal to 'view'", - "description": "Get activity log entries where usage mode is equal to 'view'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - }, - "Example 15": { - "summary": "Get activity log entries where usage mode is equal to 'edit'", - "description": "Get activity log entries where usage mode is equal to 'edit'. If usage mode filter is specified `usageModeToMatch` must be specified.", - "value": { - "usageModeFilter": { - "usageModeToMatch": "edit" - } - } - }, - "Example 16": { - "summary": "Get activity log entries that meet multiple filters", - "description": "Get activity log entries since 7 days ago (inclusive), for which the username contains the word 'admin', with at least one application name matching 'MI Explore' (case-insensitive), database key that matches 'MI_Training' (case-insensitive) and usage mode equal to 'view'.", - "value": { - "dateFilter": { - "dateFrom": "2026-03-27T00:00:00Z", - "dateFromInclusive": true, - "dateToInclusive": false - }, - "usernameFilter": { - "usernameToMatch": "admin", - "matchType": "containsCaseInsensitive" - }, - "applicationNameFilter": { - "applicationNameToMatch": "MI Explore", - "matchType": "exactMatchCaseInsensitive" - }, - "databaseKeyFilter": { - "databaseKeyToMatch": "MI_Training", - "matchType": "exactMatchCaseInsensitive" - }, - "usageModeFilter": { - "usageModeToMatch": "view" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" - }, - "examples": { - "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", - "value": { - "itemType": "activityLog", - "entries": [ - { - "date": "2026-04-03T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" - }, - { - "date": "2026-04-02T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" - }, - "examples": { - "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", - "value": { - "itemType": "activityLog", - "entries": [ - { - "date": "2026-04-03T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" - }, - { - "date": "2026-04-02T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaActivityLogEntriesInfo" - }, - "examples": { - "Example 1": { - "summary": "Example response for getting activity log entries.", - "description": "Example response for getting activity log entries.", - "value": { - "itemType": "activityLog", - "entries": [ - { - "date": "2026-04-03T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Viewer" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "edit" - }, - { - "date": "2026-04-02T00:00:00+00:00", - "username": "mi_user", - "applicationNames": [ - "MI Explore", - "Server API" - ], - "databaseKey": "MI_TRAINING", - "usageMode": "view" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}:aggregations": { - "post": { - "tags": [ - "Aggregation" - ], - "summary": "Runs an aggregation against the table.", - "operationId": "DatabaseAggregationForTableWithIdentity", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "f4805f16-7221-404d-b0ce-34ac19cf6334", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", + "Example 30": { + "summary": "Free text aggregation on specific attributes", + "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { "criterion": { "all": [], @@ -4484,7 +3477,7 @@ }, "aggregationCriteria": [ { - "criterionGuid": "3aff1dbb-9cb7-4153-833a-10817091ff95", + "criterionGuid": "ed923ec8-05bd-49eb-b937-6777e8e1b9b5", "numberOfTerms": 10, "prefix": "st", "attributes": { @@ -4501,11 +3494,10 @@ }, "type": "text" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 7": { + "Example 31": { "summary": "Free text aggregation with excluded tabular columns", "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { @@ -4517,7 +3509,7 @@ }, "aggregationCriteria": [ { - "criterionGuid": "72043816-55e9-42e2-b02a-b24b9325c196", + "criterionGuid": "19238d22-e8af-4921-b55e-31be9523da51", "numberOfTerms": 10, "prefix": "st", "attributes": { @@ -4533,11 +3525,10 @@ }, "type": "text" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 8": { + "Example 32": { "summary": "Aggregation with query", "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { @@ -4562,18 +3553,17 @@ "attributeAggregationCriterionType": "value", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } }, - "application/json": { + "application/*+json": { "schema": { "$ref": "#/components/schemas/GsaAggregationsRequest" }, "examples": { - "Example 1": { + "Example 25": { "summary": "Attribute exists aggregation", "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", "value": { @@ -4593,11 +3583,10 @@ "attributeAggregationCriterionType": "exists", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 2": { + "Example 26": { "summary": "Numeric attribute value aggregation", "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", "value": { @@ -4617,11 +3606,10 @@ "attributeAggregationCriterionType": "value", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 3": { + "Example 27": { "summary": "Text attribute value aggregation", "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", "value": { @@ -4643,11 +3631,10 @@ "attributeAggregationCriterionType": "value", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 4": { + "Example 28": { "summary": "Text attribute value aggregation with prefix", "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", "value": { @@ -4669,11 +3656,10 @@ "attributeAggregationCriterionType": "value", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 5": { + "Example 29": { "summary": "Free text aggregation", "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", "value": { @@ -4685,7 +3671,7 @@ }, "aggregationCriteria": [ { - "criterionGuid": "f4805f16-7221-404d-b0ce-34ac19cf6334", + "criterionGuid": "a4914abc-c13f-4386-b30d-f45cedd9f365", "numberOfTerms": 10, "prefix": "st", "attributes": { @@ -4696,11 +3682,10 @@ }, "type": "text" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 6": { + "Example 30": { "summary": "Free text aggregation on specific attributes", "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", "value": { @@ -4712,7 +3697,7 @@ }, "aggregationCriteria": [ { - "criterionGuid": "3aff1dbb-9cb7-4153-833a-10817091ff95", + "criterionGuid": "ed923ec8-05bd-49eb-b937-6777e8e1b9b5", "numberOfTerms": 10, "prefix": "st", "attributes": { @@ -4729,11 +3714,10 @@ }, "type": "text" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 7": { + "Example 31": { "summary": "Free text aggregation with excluded tabular columns", "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", "value": { @@ -4745,7 +3729,7 @@ }, "aggregationCriteria": [ { - "criterionGuid": "72043816-55e9-42e2-b02a-b24b9325c196", + "criterionGuid": "19238d22-e8af-4921-b55e-31be9523da51", "numberOfTerms": 10, "prefix": "st", "attributes": { @@ -4761,11 +3745,10 @@ }, "type": "text" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 8": { + "Example 32": { "summary": "Aggregation with query", "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", "value": { @@ -4790,464 +3773,260 @@ "attributeAggregationCriterionType": "value", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } - }, - "text/json": { + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAggregationsResponse" + } + } + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/bulk": { + "post": { + "tags": [ + "Bulk" + ], + "summary": "Handles multiple requests.\r\nThe requests should be independent - they could be executed in any order.\r\nThe response will contain a response item for each request item, in the same order as the request items.\r\nRequests that return file or image responses cannot be sent via the bulk endpoint.", + "operationId": "Bulk", + "requestBody": { + "content": { + "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaBulkRequest" + }, + "examples": { + "Example 1": { + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "criterionGuid": "f4805f16-7221-404d-b0ce-34ac19cf6334", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, { - "criterionGuid": "3aff1dbb-9cb7-4153-833a-10817091ff95", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 2": { + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "criterionGuid": "72043816-55e9-42e2-b02a-b24b9325c196", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } }, - "application/*+json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" + "$ref": "#/components/schemas/GsaBulkRequest" }, "examples": { "Example 1": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 3": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" + }, { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 4": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } - }, - "Example 5": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaBulkRequest" + }, + "examples": { + "Example 1": { + "summary": "Edit two attributes", + "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "criterionGuid": "f4805f16-7221-404d-b0ce-34ac19cf6334", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 6": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", + "method": "POST", + "body": { + "type": "dateTime", + "defaultThresholdType": "exists", + "name": "Casting Date" + } + }, { - "criterionGuid": "3aff1dbb-9cb7-4153-833a-10817091ff95", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "PATCH", + "body": { + "type": "discrete", + "defaultThresholdType": "exists", + "name": "Metals (updated)" + } } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, - "Example 7": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", + "Example 2": { + "summary": "Get attributes and meta-attributes from different tables.", + "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ + "requests": [ { - "criterionGuid": "72043816-55e9-42e2-b02a-b24b9325c196", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 8": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" + "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", + "method": "GET" }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", + "method": "GET" + }, + { + "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", + "method": "GET" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } } } @@ -5260,54 +4039,262 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:aggregations": { - "post": { - "tags": [ - "Aggregation" - ], - "summary": "Runs an aggregation against the table.", - "operationId": "DatabaseAggregationForTableWithGuid", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "$ref": "#/components/schemas/GsaBulkInfo" + }, + "examples": { + "Example 1": { + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", + "value": { + "data": [ + { + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + { + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaBulkInfo" + }, + "examples": { + "Example 1": { + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", + "value": { + "data": [ + { + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + { + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaBulkInfo" + }, + "examples": { + "Example 1": { + "summary": "Bulk response for editing two attributes.", + "description": "The bulk response includes a response item for each request sent.", + "value": { + "data": [ + { + "status": 201, + "body": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + }, + "headers": { + "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + { + "status": 200, + "body": { + "isMultiValued": false, + "defaultThresholdType": "exists", + "info": { + "typeCode": "DISC", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Metals (updated)", + "isMetaAttribute": false + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals (updated)", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + }, + "headers": {} + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get a datum for a given database, table, record history, record version and attribute.", + "operationId": "GetDatumForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -5334,19801 +4321,247 @@ ], "type": "string" } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" + } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatum" }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" + "examples": { + "Example 1": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 2": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 3": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 4": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 5": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 7": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 8": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 9": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 10": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "84bd8292-0d3f-4232-9aca-236303f6a9f0", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "7af11be3-78e7-479a-b6d6-278ccea59df2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "80f1b259-f45c-49f2-9847-c910aa6cdd99", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "84bd8292-0d3f-4232-9aca-236303f6a9f0", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "7af11be3-78e7-479a-b6d6-278ccea59df2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "80f1b259-f45c-49f2-9847-c910aa6cdd99", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "84bd8292-0d3f-4232-9aca-236303f6a9f0", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "7af11be3-78e7-479a-b6d6-278ccea59df2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "80f1b259-f45c-49f2-9847-c910aa6cdd99", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 9": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 10": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 11": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 12": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 13": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "84bd8292-0d3f-4232-9aca-236303f6a9f0", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 14": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "7af11be3-78e7-479a-b6d6-278ccea59df2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 15": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "80f1b259-f45c-49f2-9847-c910aa6cdd99", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 16": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}:aggregations": { - "post": { - "tags": [ - "Aggregation" - ], - "summary": "Runs an aggregation against the database.", - "operationId": "DatabaseAggregation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "3d9faa2a-9583-46c4-a760-2a5a27401c6c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "27dc3edb-df62-47c1-a6bf-f4cb4b0cc2f5", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "47ab5ad6-01c3-43b2-a0e4-cfb187ef5d4c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "3d9faa2a-9583-46c4-a760-2a5a27401c6c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "27dc3edb-df62-47c1-a6bf-f4cb4b0cc2f5", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "47ab5ad6-01c3-43b2-a0e4-cfb187ef5d4c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "3d9faa2a-9583-46c4-a760-2a5a27401c6c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "27dc3edb-df62-47c1-a6bf-f4cb4b0cc2f5", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "47ab5ad6-01c3-43b2-a0e4-cfb187ef5d4c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 17": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 18": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 19": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 20": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 21": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "3d9faa2a-9583-46c4-a760-2a5a27401c6c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 22": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "27dc3edb-df62-47c1-a6bf-f4cb4b0cc2f5", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 23": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "47ab5ad6-01c3-43b2-a0e4-cfb187ef5d4c", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 24": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/integration-schemas/{schema}:aggregations": { - "post": { - "tags": [ - "Aggregation" - ], - "summary": "Runs an aggregation against the integration schema.", - "operationId": "IntegrationAggregation", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c40e9c4f-4114-4feb-81d8-120b7c8cb2f2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "74bdfcc1-4793-46f1-bd56-d585a79f1a34", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c4df81ec-6cfd-41d8-bec5-7116d0491f9e", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c40e9c4f-4114-4feb-81d8-120b7c8cb2f2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "74bdfcc1-4793-46f1-bd56-d585a79f1a34", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c4df81ec-6cfd-41d8-bec5-7116d0491f9e", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c40e9c4f-4114-4feb-81d8-120b7c8cb2f2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "74bdfcc1-4793-46f1-bd56-d585a79f1a34", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c4df81ec-6cfd-41d8-bec5-7116d0491f9e", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsRequest" - }, - "examples": { - "Example 25": { - "summary": "Attribute exists aggregation", - "description": "Simple aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute.", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "exists", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 26": { - "summary": "Numeric attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 8965 (Counter). Returns the count of records with a value for this attribute, along with its minimum and maximum values", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "type": "integer" - }, - "identity": 8965, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 27": { - "summary": "Text attribute value aggregation", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns the count of records with a value for this attribute, along with a list of its 10 most common terms", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 28": { - "summary": "Text attribute value aggregation with prefix", - "description": "Aggregation in MI_TRAINING on an integer attribute with identity 10907 (CAS Number). Returns a list of the 10 most common terms in this attribute that start with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "st", - "type": "shortText" - }, - "identity": 10907, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 29": { - "summary": "Free text aggregation", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in all attributes and tabular local columns that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c40e9c4f-4114-4feb-81d8-120b7c8cb2f2", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "all" - }, - "localColumns": { - "filterOn": "all" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 30": { - "summary": "Free text aggregation on specific attributes", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in the attributes -4 (record name), -7 (short name) and 10907 (CAS Number) that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "74bdfcc1-4793-46f1-bd56-d585a79f1a34", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "identities": [ - -4, - -7, - 10907 - ], - "guids": [], - "filterOn": "specific" - }, - "localColumns": { - "filterOn": "none" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 31": { - "summary": "Free text aggregation with excluded tabular columns", - "description": "Aggregation in MI_TRAINING that returns a list of the 10 most common terms in tabular local columns excluding 'Comments' and 'Category' from 'Restricted substances that may be used in the manufacture of this material' tabular attribute from 'MaterialUniverse' table that begin with the characters 'st' (case insensitive)", - "value": { - "criterion": { - "all": [], - "any": [], - "none": [], - "type": "boolean" - }, - "aggregationCriteria": [ - { - "criterionGuid": "c4df81ec-6cfd-41d8-bec5-7116d0491f9e", - "numberOfTerms": 10, - "prefix": "st", - "attributes": { - "filterOn": "none" - }, - "localColumns": { - "excludedIdentities": [], - "excludedGuids": [ - "d5c215fe-6305-407b-a830-cc5ff14e4cf9", - "bfb3edea-be3e-4598-a711-6abb171a4569" - ], - "filterOn": "exclude" - }, - "type": "text" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - }, - "Example 32": { - "summary": "Aggregation with query", - "description": "Aggregation in MI_TRAINING on a discrete attribute with identity 5876 (Rating), that only returns the common terms in records that also match the search criterion that the picture attribute 5872 (Issue Date) exists", - "value": { - "criterion": { - "innerCriterion": { - "type": "dateTime" - }, - "identity": 5872, - "isMetaAttribute": false, - "attributeCriterionType": "exists", - "type": "attribute" - }, - "aggregationCriteria": [ - { - "innerCriterion": { - "numberOfTerms": 10, - "prefix": "", - "type": "discreteText" - }, - "identity": 5876, - "isMetaAttribute": false, - "attributeAggregationCriterionType": "value", - "type": "attribute" - } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAggregationsResponse" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/blob-infos/dataupdater": { - "get": { - "tags": [ - "BlobInfos" - ], - "summary": "Get a list of all blob descriptors for databases that the user is admin of.", - "operationId": "GetAllDataUpdaterBlobInfos", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - } - } - } - } - } - }, - "/v1alpha/blob-infos/dataupdater/{database-key}/{blob-path}": { - "get": { - "tags": [ - "BlobInfos" - ], - "summary": "Get a list of blob descriptors for a specific database, optionally limited by their relative path.", - "operationId": "GetDataUpdaterBlobInfos", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database key.", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "blob-path", - "in": "path", - "description": "Path to look under (without the blob name). Can be empty", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "recursive", - "in": "query", - "description": "Whether to look under sub-paths as well.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - } - } - } - } - } - }, - "/v1alpha/blobs/dataUpdater/{database-key}/{blobPath}": { - "get": { - "tags": [ - "Blobs" - ], - "summary": "Retrieve DataUpdater blob contents by its path.", - "operationId": "DownloadDataUpdaterBlob", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database key", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "blobPath", - "in": "path", - "description": "Blob path to a single blob (including its name).", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "description": "Blob not found" - } - } - }, - "put": { - "tags": [ - "Blobs" - ], - "summary": "Store DataUpdater blob contents.", - "operationId": "UploadDataUpdaterBlob", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database key", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "blobPath", - "in": "path", - "description": "Blob path to a single blob (including its name).", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBlobInfoDto" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Blobs" - ], - "summary": "Delete DataUpdater blob.", - "operationId": "DeleteDataUpdaterBlob", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database key", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "blobPath", - "in": "path", - "description": "Blob path to a single blob (including its name).", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/bulk": { - "post": { - "tags": [ - "Bulk" - ], - "summary": "Handles multiple requests.\r\nThe requests should be independent - they could be executed in any order.\r\nThe response will contain a response item for each request item, in the same order as the request items.\r\nRequests that return file or image responses cannot be sent via the bulk endpoint.", - "operationId": "Bulk", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } - } - ] - } - }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } - } - ] - } - }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } - } - ] - } - }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkRequest" - }, - "examples": { - "Example 1": { - "summary": "Edit two attributes", - "description": "This example demonstrates how to edit several attributes in the 'MI_TRAINING' database in a single request. It creates a new date-time attribute 'Casting Date' in the 'Metals Pedigree' table, and renames the 'Metal' attribute in the 'MaterialsUniverse' table.", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes", - "method": "POST", - "body": { - "type": "dateTime", - "defaultThresholdType": "exists", - "name": "Casting Date" - } - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "PATCH", - "body": { - "type": "discrete", - "defaultThresholdType": "exists", - "name": "Metals (updated)" - } - } - ] - } - }, - "Example 2": { - "summary": "Get attributes and meta-attributes from different tables.", - "description": "This example demonstrates how to get different attributes in the MI_TRAINING database in a single request. The attributes are: 'Alloy' in the 'Metals Pedigree' table; 'Metals' in the 'MaterialUniverse' table; and meta-attribute 'Notes' on attribute 'Flammability' in the 'MaterialUniverse' table", - "value": { - "requests": [ - { - "path": "/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/A93A36C1-78D6-4254-B245-C7445D1038DA", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/attributes/0000000b-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - }, - { - "path": "/v1alpha/databases/MI_Training/tables/0000dd92-0011-4fff-8fff-0000ffff0000/meta-attributes/00000298-0001-4fff-8fff-dd92ffff0000", - "method": "GET" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" - }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - }, - "headers": {} - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" - }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - }, - "headers": {} - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaBulkInfo" - }, - "examples": { - "Example 1": { - "summary": "Bulk response for editing two attributes.", - "description": "The bulk response includes a response item for each request sent.", - "value": { - "data": [ - { - "status": 201, - "body": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - }, - "headers": { - "location": "https://host-name/v1alpha/databases/MI_Training/tables/ad27baf0-42e9-4136-bc96-9dbbf116e265/attributes/fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - { - "status": 200, - "body": { - "isMultiValued": false, - "defaultThresholdType": "exists", - "info": { - "typeCode": "DISC", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Metals (updated)", - "isMetaAttribute": false - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Metals (updated)", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - }, - "headers": {} - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/currencies": { - "get": { - "tags": [ - "Currencies" - ], - "summary": "All the currencies configured on the server.", - "operationId": "GetCurrencies", - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrenciesInfo" - }, - "examples": { - "Example 1": { - "summary": "Currencies", - "description": "Example of currencies", - "value": { - "currencies": [ - { - "code": "GBP", - "name": "Pound Sterling", - "factor": 0.754 - }, - { - "code": "USD", - "name": "US Dollar", - "factor": 1.0 - }, - { - "code": "CHF", - "name": "Swiss Franc", - "factor": 0.814 - } - ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/currencies/{currencyCode}": { - "get": { - "tags": [ - "Currencies" - ], - "summary": "Gets the currency with the specified code.", - "operationId": "GetCurrency", - "parameters": [ - { - "name": "currencyCode", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrency" - }, - "examples": { - "Example 1": { - "summary": "US Dollar", - "description": "Example of US Dollar currency", - "value": { - "code": "USD", - "name": "US Dollar", - "factor": 1.0 - } - }, - "Example 2": { - "summary": "Pound Sterling", - "description": "Example of Pound Sterling currency", - "value": { - "code": "GBP", - "name": "Pound Sterling", - "factor": 0.754 - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Currency not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given database, table, record history, record version and attribute.", - "operationId": "GetDatumForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "filterEmptyCells", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "filterEmptyRows", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 2": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 3": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 4": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 5": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 6": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 7": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 8": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 9": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 10": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given attribute and the latest version of a record history in given database and table.", - "operationId": "GetDatumForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "filterEmptyCells", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "filterEmptyRows", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 11": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 12": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 13": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 14": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 15": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 16": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 17": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 18": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 19": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 20": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given database, record history, record version and attribute.", - "operationId": "GetDatumForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "filterEmptyCells", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "filterEmptyRows", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 21": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 22": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 23": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 24": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 25": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 26": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 27": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 28": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 29": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 30": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given attribute and the latest version of a record history in given database.", - "operationId": "GetDatumForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "filterEmptyCells", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "filterEmptyRows", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 31": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 32": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 33": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 34": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 35": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 36": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 37": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 38": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 39": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 40": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given database, table, record history, record version and attribute. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Attribute is not an exportable type" - }, - "404": { - "description": "Database, table, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given attribute and the latest version of a record history in given database and table. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Attribute is not an exportable type" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given database, record history, record version and attribute. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Attribute is not an exportable type" - }, - "404": { - "description": "Database, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given attribute and the latest version of a record history in given database. Must be a file or picture attribute.", - "operationId": "ExportBinaryDataForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Attribute is not an exportable type" - }, - "404": { - "description": "Database, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given database, table, record history, record version, tabular attribute, row and column.", - "operationId": "GetCellDatumForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 2": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database and table.", - "operationId": "GetCellDatumForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 3": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 4": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given database, record history, record version, tabular attribute, row and column.", - "operationId": "GetCellDatumForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 5": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 6": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, record history, record version, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database.", - "operationId": "GetCellDatumForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 7": { - "summary": "Integer cell datum.", - "description": "Example response for an integer cell datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 8": { - "summary": "Logical cell datum.", - "description": "Example response for a logical cell datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - } - } - } - } - }, - "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given database, table, record history, record version, tabular attribute, row and column. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Column is not an exportable type" - }, - "404": { - "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database and table. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Column is not an exportable type" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given database, record history, record version, tabular attribute, row and column. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Column is not an exportable type" - }, - "404": { - "description": "Database, record history, record version, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { - "get": { - "tags": [ - "Data" - ], - "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database. Must be a file or picture column.", - "operationId": "ExportCellBinaryDataForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "maxWidth", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "maxHeight", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "400": { - "description": "Column is not an exportable type" - }, - "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a datum for a given attribute and record history in a given database and table.", - "operationId": "SetDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:30.9890285+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:30.9890285+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:30.9890285+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 5": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 6": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 7": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 8": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 9": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 10": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:30.9890285+00:00" - } - }, - "Example 11": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 12": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 13": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 14": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 2": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 3": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 4": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 5": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 6": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 7": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 8": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 9": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 10": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - }, - "422": { - "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database and table.", - "operationId": "DeleteDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a datum for a given attribute and record history in a given database.", - "operationId": "SetDatumForAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0170216+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0170216+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0170216+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 15": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 16": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 17": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 18": { - "summary": "Discrete datum - single valued", - "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "00000583-0007-4fff-8fff-0083ffff0000" - } - ] - } - }, - "Example 19": { - "summary": "Discrete datum - multi valued", - "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "discrete", - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - }, - "Example 20": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 21": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 22": { - "summary": "Point datum - single valued", - "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 23": { - "summary": "Point datum - multi valued with parameters", - "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.26, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.16 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.31, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.56 - } - }, - { - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ] - } - }, - "Example 24": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0170216+00:00" - } - }, - "Example 25": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 26": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - }, - "Example 27": { - "summary": "Tabular datum", - "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "linkingValue": "85535-84-8" - }, - { - "linkingValue": "1327-53-3" - } - ] - } - }, - "Example 28": { - "summary": "Tabular datum - rows reordering", - "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "setDatumType": "tabular", - "rows": [ - { - "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", - "linkingValue": "85535-84-8" - }, - { - "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", - "linkingValue": "84-74-2" - }, - { - "guid": "cc775763-3986-4ba6-8722-45b3940c5269", - "linkingValue": "117-81-7" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 11": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 12": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 13": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 14": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 15": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 16": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 17": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 18": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 19": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 20": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - }, - "422": { - "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database.", - "operationId": "DeleteDatumForAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0260194+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0260194+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0260194+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 1": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 2": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 3": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 4": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 5": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 6": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 7": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0260194+00:00" - } - }, - "Example 8": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 9": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 21": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 22": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 23": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 24": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 25": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 26": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 27": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 28": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 29": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 30": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "DeleteCellDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0290166+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0290166+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0290166+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaSetDatum" - }, - "examples": { - "Example 10": { - "summary": "Integer datum", - "description": "This example demonstrates how to set the value for an integer cell datum.", - "value": { - "setDatumType": "integer", - "value": 34 - } - }, - "Example 11": { - "summary": "Logical datum", - "description": "This example demonstrates how to set the value for a logical cell datum.", - "value": { - "setDatumType": "logical", - "value": true - } - }, - "Example 12": { - "summary": "Short text datum", - "description": "This example demonstrates how to set the value for a short text cell datum.", - "value": { - "setDatumType": "shortText", - "value": "Resistant to strong acid" - } - }, - "Example 13": { - "summary": "Range datum", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 27.3, - "inclusiveness": "inclusive" - }, - "highEndpoint": { - "value": 31.2, - "inclusiveness": "inclusive" - }, - "estimated": false - } - }, - "Example 14": { - "summary": "Range datum with upper range unbounded", - "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", - "value": { - "setDatumType": "range", - "lowEndpoint": { - "value": 750.0, - "inclusiveness": "exclusive" - }, - "estimated": false - } - }, - "Example 15": { - "summary": "Point datum", - "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", - "value": { - "setDatumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7 - } - ] - } - }, - "Example 16": { - "summary": "DateTime datum", - "description": "This example demonstrates how to set the value for a DateTime cell datum.", - "value": { - "setDatumType": "datetime", - "value": "2026-04-03T08:12:31.0290166+00:00" - } - }, - "Example 17": { - "summary": "Hyperlink datum", - "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", - "value": { - "setDatumType": "hyperLink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow" - } - }, - "Example 18": { - "summary": "Long Text datum", - "description": "This example demonstrates how to set the value for a Long Text cell datum.", - "value": { - "setDatumType": "longText", - "richTextValue": { - "text": "Debug Text", - "type": "plain" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatum" - }, - "examples": { - "Example 31": { - "summary": "Integer datum.", - "description": "Example response for an integer datum with a value of 7.", - "value": { - "datumType": "integer", - "value": 7, - "notApplicable": "applicable" - } - }, - "Example 32": { - "summary": "Logical datum.", - "description": "Example response for a logical datum with a value of 'true'", - "value": { - "datumType": "logical", - "value": true, - "notApplicable": "applicable" - } - }, - "Example 33": { - "summary": "Short Text datum.", - "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "shortText", - "value": "Resistant to strong acid", - "notApplicable": "applicable" - } - }, - "Example 34": { - "summary": "Long Text datum.", - "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", - "value": { - "datumType": "longText", - "richTextValue": { - "text": "Resistant to strong acid", - "type": "plain" - }, - "notApplicable": "applicable" - } - }, - "Example 35": { - "summary": "Hyperlink datum.", - "description": "Example response for a hyperlink datum with a value of localhost", - "value": { - "datumType": "hyperlink", - "address": "http://localhost", - "description": "local host", - "target": "newWindow", - "notApplicable": "applicable" - } - }, - "Example 36": { - "summary": "DateTime datum.", - "description": "Example response for a DateTime datum with a value of January 1st, 2000", - "value": { - "datumType": "dateTime", - "dateTime": "2000-01-01T00:00:00+00:00", - "notApplicable": "applicable" - } - }, - "Example 37": { - "summary": "Range datum.", - "description": "Example response for a range datum with both low and high range values set", - "value": { - "datumType": "range", - "highEndpoint": { - "value": 1275.0, - "inclusiveness": "exclusive" - }, - "lowEndpoint": { - "value": 1200.0, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 38": { - "summary": "Range datum - low bound only.", - "description": "Example response for a range datum with only the low range value set", - "value": { - "datumType": "range", - "lowEndpoint": { - "value": 1.75, - "inclusiveness": "inclusive" - }, - "estimated": false, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "notApplicable": "applicable" - } - }, - "Example 39": { - "summary": "Point datum - single valued.", - "description": "Example response for a single valued point datum", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 12.7, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - } - } - ], - "notApplicable": "applicable" - } - }, - "Example 40": { - "summary": "Point datum - multi valued with parameters.", - "description": "Example response for a multi valued point datum with parameters", - "value": { - "datumType": "point", - "estimated": false, - "values": [ - { - "pointValue": 1.2, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 273.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Weak acids", - "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" - } - } - } - ] - }, - { - "pointValue": 1.4, - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "parametersAndValues": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 303.16, - "unit": { - "symbol": "K", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } - }, - { - "parameter": { - "name": "Chemical Environment", - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - }, - "parameterDataValue": { - "parameterType": "discrete", - "parameterValue": { - "type": "discrete", - "name": "Strong acids", - "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - } - ] - } - ], - "notApplicable": "applicable" - } - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row or column not found" - } - } - }, - "delete": { - "tags": [ - "Data" - ], - "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "DeleteCellDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row, column or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a file datum for a given attribute and record history in a given database and table.", - "operationId": "SetFileDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } - }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" - }, - "Target": { - "style": "form" - }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a file datum for a given attribute and record history in a given database.", - "operationId": "SetFileDatumForAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } - }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" - }, - "Target": { - "style": "form" - }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a picture datum for a given attribute and record history in a given database and table.", - "operationId": "SetPictureDatumForAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - }, - "415": { - "description": "Invalid image file" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a picture datum for a given attribute and record history in a given database.", - "operationId": "SetPictureDatumForAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - }, - "415": { - "description": "Invalid image file" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellFileDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } - }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" - }, - "Target": { - "style": "form" - }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellFileDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "File": { - "type": "string", - "description": "File to import.", - "format": "binary" - }, - "Description": { - "type": "string", - "description": "File description." - }, - "Target": { - "type": "string", - "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." - }, - "AllowIndex": { - "type": "boolean", - "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." - } - } - }, - "encoding": { - "File": { - "style": "form" - }, - "Description": { - "style": "form" - }, - "Target": { - "style": "form" - }, - "AllowIndex": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row or column not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database and table.", - "operationId": "SetCellPictureDatumForTabularAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, tabular attribute, row or column not found" - }, - "415": { - "description": "Invalid image file" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { - "put": { - "tags": [ - "Data" - ], - "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database.", - "operationId": "SetCellPictureDatumForTabularAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "row-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "column-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "Picture": { - "type": "string", - "description": "Picture to import.", - "format": "binary" - } - } - }, - "encoding": { - "Picture": { - "style": "form" - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPictureDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, tabular attribute, row or column not found" - }, - "415": { - "description": "Invalid image file" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { - "post": { - "tags": [ - "Data" - ], - "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database and table.", - "operationId": "SetDatumNotApplicableFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { - "post": { - "tags": [ - "Data" - ], - "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database.", - "operationId": "SetDatumNotApplicable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { - "post": { - "tags": [ - "Data" - ], - "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database and table.", - "operationId": "AppendValuesForDiscreteAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 1": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 2": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, discrete attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { - "post": { - "tags": [ - "Data" - ], - "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database.", - "operationId": "AppendValuesForDiscreteAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendDiscreteValues" - }, - "examples": { - "Example 3": { - "summary": "Append single discrete value", - "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - } - ] - } - }, - "Example 4": { - "summary": "Append multiple discrete values", - "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "discreteValues": [ - { - "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" - }, - { - "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" - }, - { - "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, discrete attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { - "post": { - "tags": [ - "Data" - ], - "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database and table.", - "operationId": "AppendValuesForPointAttributeFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 1": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPointDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history, point attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { - "post": { - "tags": [ - "Data" - ], - "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database.", - "operationId": "AppendValuesForPointAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppendPointValues" - }, - "examples": { - "Example 3": { - "summary": "Append single point value with parameters", - "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - } - ] - } - }, - "Example 4": { - "summary": "Append multiple point values with parameters", - "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", - "value": { - "values": [ - { - "pointValue": 1190.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - } - } - ] - }, - { - "pointValue": 1240.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - } - } - ] - }, - { - "pointValue": 1290.0, - "parametersAndValues": [ - { - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 293.0 - } - }, - { - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterValue": { - "parameterType": "discrete", - "parameterValue": { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - } - } - ] - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPointDatum" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, record history, point attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}:search-index-status": { - "get": { - "tags": [ - "Database" - ], - "summary": "GetSearch Index Status for a given database", - "operationId": "GetSearchIndexStatus", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "include-errors", - "in": "query", - "description": "", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" - } - } - } - }, - "403": { - "description": "Forbidden is returned if include diagnostics is requested and the current user is not an administrator" - }, - "404": { - "description": "Database key not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-name}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromTableName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-identity}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayout", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "layout-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-identity}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutWithTableName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "layout-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-name}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-identity", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "layout-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-name}:generate-integration-schema": { - "get": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromLayoutNameWithTableName", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "layout-name", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/standard-names:generate-integration-schema": { - "post": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema with attributes for each provided standard name in the given database. The user must be an Admin user for the database.", - "operationId": "GenerateSchemaFromStandardNames", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json-patch+json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/standard-names:generate-integration-schema": { - "post": { - "tags": [ - "Database" - ], - "summary": "Generate an integration schema with attributes for each provided standard name. This will include attribute from all loaded databases for which the user is an Admin.", - "operationId": "GenerateSchemaFromStandardNamesAllDatabases", - "requestBody": { - "description": "", - "content": { - "application/json-patch+json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}:export": { - "post": { - "tags": [ - "DataExport" - ], - "summary": "Export data from the given database.", - "operationId": "ExportData", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordHistoryGuids": [ - "ba22491d-b470-42cf-80d7-531ff81b1583", - "d0237d48-ddd2-4916-b24c-86ba51f25b52" - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "00000144-0001-4fff-8fff-dd92ffff0000" - }, - { - "attributeType": "simple", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - } - ], - "recordProperties": [ - "fullName", - "recordColor" - ], - "recordVersionGuids": [ - "00000026-000e-4fff-8fff-dd92ffff0000", - "0000098c-000e-4fff-8fff-dd92ffff0000" - ] - } - }, - "Example 3": { - "summary": "Linked Records Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 4": { - "summary": "Linked Records Export - no target specified", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", - "value": { - "attributes": [ - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 5": { - "summary": "Linked Records Export - In Reversed Direction", - "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": true, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" - ] - } - }, - "Example 6": { - "summary": "Linked Records Export - include indirect links", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "include", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 7": { - "summary": "Linked Records Export - exclude indirect links", - "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "exclude", - "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "f3182449-8042-4bd2-89e5-88505cbbc85f" - ] - } - }, - "Example 8": { - "summary": "Linked Records Export - Smart Link", - "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the smart record link group 'Tensile Test Data'.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "smartLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "c8b93abd-f834-464e-b02e-a3cb52a04507" - ] - } - }, - "Example 9": { - "summary": "Linked Data Export", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 10": { - "summary": "Linked Data Export - Rollup", - "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", - "value": { - "attributes": [ - { - "attributeType": "simple", - "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" - }, - { - "localData": [], - "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "attributeType": "link", - "linkAttributeType": "recordLink", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName", - "recordColor" - ], - "attributes": [ - { - "rollUpType": "mean", - "attributeType": "simple", - "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "b3503337-8287-4946-b312-2100fb51779d" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" - } - ], - "recordProperties": [ - "tableName", - "fullName" - ], - "recordHistoryGuids": [ - "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" - ] - } - }, - "Example 11": { - "summary": "Tabular Data Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 12": { - "summary": "Tabular Data Export - no target specified", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "localData": [], - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 13": { - "summary": "Tabular Data Filtered Export", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", - "value": { - "attributes": [ - { - "localData": [ - { - "attributeType": "simple", - "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" - } - ], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - } - ], - "linkedRecordsExportBehavior": { - "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", - "rollUpTypes": [], - "linkedRecordsCriterion": { - "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", - "type": "subset" - } - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 14": { - "summary": "Tabular Data With Summary Row and Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "summaryRollUpType": "listDistinct", - "attributeType": "simple", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - { - "rollUpType": "max", - "attributeType": "simple", - "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" - } - ], - "linkedRecordsExportBehavior": { - "summaryRollUpType": "listDistinct", - "rollUpTypes": [] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "17877254-3a26-4a28-94d6-9f6be164914c" - ] - } - }, - "Example 15": { - "summary": "Tabular Data With Linked Columns Tabular Rollup", - "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", - "value": { - "attributes": [ - { - "localData": [], - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "attributes": [ - { - "localData": [], - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", - "attributeType": "link", - "linkAttributeType": "tabularAttribute", - "exportInReversedDirection": false, - "recordProperties": [ - "fullName" - ], - "attributes": [ - { - "attributeType": "simple", - "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" - }, - { - "rollUpType": "min", - "attributeType": "simple", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - } - ], - "linkedRecordsExportBehavior": { - "rollUpTypes": [ - "list" - ] - }, - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - ], - "indirectLinksBehavior": "fromLinkDefinition", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ], - "recordProperties": [ - "fullName" - ], - "recordHistoryGuids": [ - "8348e2a2-7b97-44e7-94a1-cb8358a06407" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - } - } - }, - "404": { - "description": "Database not found" - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/integration-schemas/{schema}:export": { - "post": { - "tags": [ - "DataExport" - ], - "summary": "Export data from the integration schema.", - "operationId": "ExportDataFromIntegrationSchema", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" - }, - "examples": { - "Example 1": { - "summary": "Data Export by Record History", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", - "value": { - "recordReferences": [ - { - "recordReferenceType": "history", - "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", - "databaseKey": "MI_TRAINING" - }, - { - "recordReferenceType": "history", - "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - }, - "Example 2": { - "summary": "Data Export by Record Version", - "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", - "value": { - "recordReferences": [ - { - "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - }, - { - "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", - "recordReferenceType": "version", - "databaseKey": "MI_TRAINING" - } - ], - "attributeIdentities": [ - 1 - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataExportResponse" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/dataupdater/updates": { - "get": { - "tags": [ - "DataUpdater" - ], - "operationId": "GetAllUpdates", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}": { - "get": { - "tags": [ - "DataUpdater" - ], - "operationId": "GetUpdatesForDatabase", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Register an update", - "operationId": "RegisterUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRegisterUpdateRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get registered update.\r\nRetrieves info about an update that was registered by the Apply side.", - "operationId": "GetUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdate" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DataUpdater" - ], - "summary": "Deletes an update if it is in a deletable state.", - "operationId": "DeleteUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "404": { - "description": "Update not found" - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}/header": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get update header from update file.\r\nWorks even for unregistered updates (i.e. ones just created by the Create side).", - "operationId": "GetUpdateHeader", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:dry-run": { - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Start a dry run job for a given update", - "operationId": "DryRunUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:apply": { - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Start an apply job for a given update", - "operationId": "ApplyUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/updates/{database-key}/{update-token-guid}:finalize": { - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Start a finalize job for a given update", - "operationId": "FinalizeUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "update-token-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/projects/{database-key}": { - "get": { - "tags": [ - "DataUpdater" - ], - "operationId": "GetProjectsForDatabase", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/projects/{database-key}:fill-in-fallback-ids": { - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Starts a long-running operation of generating fallback identifiers for a given database.\r\nReturns immediately.\r\nUser is expected to watch MI Server logs for progress and errors.", - "operationId": "FillInFallbackIdentifiers", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/dataupdater/projects/{database-key}/{project-id}": { - "put": { - "tags": [ - "DataUpdater" - ], - "summary": "Creates a new project or updates an existing one.", - "operationId": "CreateOrUpdateProject", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "project-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - } - } - }, - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "DataUpdater" - ], - "summary": "Deletes a project.", - "operationId": "DeleteProject", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "project-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "post": { - "tags": [ - "DataUpdater" - ], - "summary": "Creates and queues a new 'create update' job for a given project.", - "operationId": "CreateUpdate", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "project-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataUpdateServerApiRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/profiles/{profile-id}/selections/{database-key}": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Retrieves selection based on profile and database key", - "operationId": "GetSelection", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "profile-id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaSelection" - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/jobs": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get all jobs.\r\n(pertaining to databases that the user is administrator of)", - "operationId": "GetDataUpdaterJobs", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - } - } - } - } - } - }, - "/v1alpha/dataupdater/jobs/{job-id}": { - "get": { - "tags": [ - "DataUpdater" - ], - "summary": "Get a specific job.", - "operationId": "GetDataUpdaterJob", - "parameters": [ - { - "name": "job-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataUpdaterJob" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DataUpdater" - ], - "summary": "Delete a specific job.\r\nOnly valid if job is in one of the completed states.", - "operationId": "DeleteCompletedDataUpdaterJob", - "parameters": [ - { - "name": "job-id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record/{record-guid}:findsimilar": { - "post": { - "tags": [ - "FindSimilar" - ], - "summary": "Finds similar records in a given database and table for a given record", - "operationId": "FindSimilar", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - } - } - } - }, - "/v1alpha/integration-schemas/{schema}/record/{record-guid}:findsimilar": { - "post": { - "tags": [ - "FindSimilar" - ], - "summary": "Runs a find similar calculation against the integration schema.", - "operationId": "IntegrationFindSimilar", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "record-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "uuid" - } - }, - "text/json": { - "schema": { - "type": "string", - "format": "uuid" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/{find-similar-identifier}/results": { - "post": { - "tags": [ - "FindSimilar" - ], - "summary": "Returns find similar results by identifier", - "operationId": "GetFindSimilarResults", - "parameters": [ - { - "name": "find-similar-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFindSimilarResponse" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Search not found" - } - } - } - }, - "/v1alpha/{find-similar-identifier}": { - "delete": { - "tags": [ - "FindSimilar" - ], - "summary": "Delete find similar results by identifier", - "operationId": "DeleteFindSimilarResults", - "parameters": [ - { - "name": "find-similar-identifier", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Find Similar not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get the graph for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" - }, - "examples": { - "Example 1": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get the graph for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" - }, - "examples": { - "Example 2": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get a graph for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" - }, - "examples": { - "Example 3": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, record history, record version, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { - "get": { - "tags": [ - "Graph" - ], - "summary": "Get the graph for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", - "operationId": "GetGraphForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraph" - }, - "examples": { - "Example 4": { - "summary": "Float series graph.", - "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", - "value": { - "functionalType": "float", - "series": [ - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 300.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 53.12, - "yHighValue": 54.5, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 62.58, - "yHighValue": 64.57, - "estimated": false - }, - { - "xValue": 25000.0, - "yLowValue": 73.06, - "yHighValue": 74.9, - "estimated": false - }, - { - "xValue": 12500.0, - "yLowValue": 85.34, - "yHighValue": 87.91, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - }, - { - "constraints": [ - { - "parameter": { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - "parameterDataValue": { - "parameterType": "numeric", - "parameterValue": 400.0 - } - } - ], - "points": [ - { - "xValue": 1000.0, - "yLowValue": 95.86, - "yHighValue": 97.43, - "estimated": false - }, - { - "xValue": 5000.0, - "yLowValue": 106.7, - "yHighValue": 108.42, - "estimated": true - }, - { - "xValue": 25000.0, - "yLowValue": 119.85, - "yHighValue": 121.04, - "estimated": true - }, - { - "xValue": 12500.0, - "yLowValue": 134.75, - "yHighValue": 137.19, - "estimated": false - } - ], - "graphDecoration": "linesOnly" - } - ], - "graphType": "series", - "xAxisParameter": { - "type": "numeric", - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - "constraintParameters": [ - { - "type": "numeric", - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "numberOfPoints": 8 - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { - "post": { - "tags": [ - "Graph" - ], - "summary": "Evaluate the graph for a given set of parameter values for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 1": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphValue" - }, - "examples": { - "Example 1": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } - }, - "Example 2": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } - }, - "Example 3": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } - }, - "Example 4": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { - "post": { - "tags": [ - "Graph" - ], - "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphValueForLatestFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 2": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphValue" - }, - "examples": { - "Example 5": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } - }, - "Example 6": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } - }, - "Example 7": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } - }, - "Example 8": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { - "post": { - "tags": [ - "Graph" - ], - "summary": "Evaluate the graph for a given set of parameter values for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 3": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphValue" - }, - "examples": { - "Example 9": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } - }, - "Example 10": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } - }, - "Example 11": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } - }, - "Example 12": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { - "post": { - "tags": [ - "Graph" - ], - "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", - "operationId": "EvaluateGraphValueForLatest", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphEvaluationSettings" - }, - "examples": { - "Example 4": { - "summary": "Numeric and Discrete Parameters", - "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", - "value": { - "parametersWithValues": [ - { - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "parameterValue": { - "parameterType": "numeric", - "parameterValue": 273.14 - } - }, - { - "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", - "parameterValue": { - "parameterType": "discrete", - "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGraphValue" - }, - "examples": { - "Example 13": { - "summary": "Range graph value - value exists.", - "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": false - } - }, - "Example 14": { - "summary": "Range graph value - interpolated value.", - "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", - "value": { - "graphValueType": "range", - "lowValue": 8.659, - "highValue": 8.703, - "lowValueIsInclusive": true, - "highValueIsInclusive": true, - "estimated": false, - "interpolated": true - } - }, - "Example 15": { - "summary": "Discrete graph value - value exists.", - "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", - "value": { - "graphValueType": "discrete", - "value": { - "isProtected": false, - "name": "Used in Production", - "guid": "725244fb-c182-418a-91d8-c07294990c13" - } - } - }, - "Example 16": { - "summary": "No value exists.", - "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", - "value": { - "graphValueType": "noValueExists" - } - } - } - } - } - }, - "400": { - "description": "Attribute is not a float or discrete functional attribute" - }, - "404": { - "description": "Database, table, record history, attribute or datum not found" - } - } - } - }, - "/v1alpha/help-location/url/{help-key}": { - "get": { - "tags": [ - "HelpLocation" - ], - "summary": "Returns the URL that the given helpKey maps to.", - "operationId": "GetHelpUrl", - "parameters": [ - { - "name": "help-key", - "in": "path", - "description": "The help key.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok" - } - } - } - }, - "/v1alpha/help-location/redirect/{help-key}": { - "get": { - "tags": [ - "HelpLocation" - ], - "summary": "Redirects client to the URL that the given helpKey maps to.", - "operationId": "GetHelpUrlRedirect", - "parameters": [ - { - "name": "help-key", - "in": "path", - "description": "The help key.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "302": { - "description": "Redirect to the help location." - } - } - } - }, - "/v1alpha/identities": { - "post": { - "tags": [ - "Identities" - ], - "summary": "For internal use only.\r\nTranslates guids to identities.", - "operationId": "TranslateGuidsToIdentities", - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateBetweenGuidsAndIdentitiesResponse" - } - } - } - }, - "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/guids": { - "post": { - "tags": [ - "Identities" - ], - "summary": "For internal use only.\r\nTranslates identities to GUIDs.", - "operationId": "TranslateIdentitiesToGuids", - "parameters": [ - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateIdentitiesToGuidsRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTranslateBetweenGuidsAndIdentitiesResponse" - } - } - } - }, - "400": { - "description": "Bad request" - } - } - } - }, - "/v1alpha/integration-schemas": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Lists the available integration schemas.", - "operationId": "Schemas", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Integration" - ], - "summary": "Add an integration schema. Will fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "AddSchema", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "responses": { - "201": { - "description": "Created successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "400": { - "description": "Bad request. Returns validation errors information" - }, - "403": { - "description": "Forbidden. User is not a global administrator or an administrator for the schema" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/integration-schemas/{schema}:search-index-status": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns the status of a given integration schema.", - "operationId": "GetStatusForIntegrationSchema", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "include-errors", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Not Found" - } - } - } - }, - "/v1alpha/integration-schemas:search-index-status": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns the status of all available integration schemas.", - "operationId": "AllSchemaStatus", - "parameters": [ - { - "name": "include-errors", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } - }, - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } - }, - "text/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" - } - } - } - } - }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/v1alpha/integration-schemas/{schema}": { - "put": { - "tags": [ - "Integration" - ], - "summary": "Updates an integration schema.\r\nWill fail if the schema does not exist, is not valid, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "UpdateSchema", - "parameters": [ - { - "name": "schema", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "responses": { - "201": { - "description": "Updated successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "400": { - "description": "Bad request. Returns validation errors information" - }, - "403": { - "description": "Forbidden. User is not a global administrator or an administrator for the schema" - }, - "404": { - "description": "Not Found. Schema does not exist" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - }, - "delete": { - "tags": [ - "Integration" - ], - "summary": "Delete an integration schema. Will fail if the schema does not exist, or if the user is not both a global administrator and an administrator for the schema.", - "operationId": "DeleteSchema", - "parameters": [ - { - "name": "schema", - "in": "path", - "description": "Schema to be deleted", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Schema deleted" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Schema not found" - } - } - }, - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns the full object representing the integration schema.\r\nNames and identities of source items will be populated if they can be found in the databases currently loaded in MI, otherwise just the GUIDs will be returned.", - "operationId": "GetSchema", - "parameters": [ - { - "name": "schema", - "in": "path", - "description": "The schema name.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "includeImplicitAttributes", - "in": "query", - "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/integration-schemas/{schema}/attributes": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Returns a list of the attributes defined in the integration schema.", - "operationId": "SchemaTargets", - "parameters": [ - { - "name": "schema", - "in": "path", - "description": "The schema name.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "includeImplicitAttributes", - "in": "query", - "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaIntegrationAttribute" + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } } }, "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" + "description": "Database, table, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { "get": { "tags": [ - "Integration" + "Data" ], - "summary": "Returns a list of the schema source mapping from the given table. Will fail if the database is not loaded in MI.\r\nNames and identities of source items will be populated.", - "operationId": "SchemaTableMappings", + "summary": "Get a datum for a given attribute and the latest version of a record history in given database and table.", + "operationId": "GetDatumForLatestFromTable", "parameters": [ { - "name": "schema", + "name": "database-key", "in": "path", "required": true, "schema": { @@ -25136,688 +4569,610 @@ } }, { - "name": "database-key", + "name": "table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-identity", + "name": "record-history-guid", "in": "path", "required": true, "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" - } - } - } - } - }, - "404": { - "description": "Schema not found" - }, - "422": { - "description": "MI not in attribute-based access control mode" - } - } - } - }, - "/v1alpha/job-queue/jobs": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get a list of jobs.", - "operationId": "GetJobs", - "parameters": [ - { - "name": "jobType", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "nameFilter", - "in": "query", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "descriptionFilter", + "name": "mode", "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } }, { - "name": "submitterNameFilter", - "in": "query", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } }, { - "name": "pageSize", + "name": "filterEmptyCells", "in": "query", "schema": { - "type": "integer", - "format": "int32" + "type": "boolean" } }, { - "name": "pageNumber", + "name": "filterEmptyRows", "in": "query", "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Create a new job.", - "operationId": "CreateJob", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Created successfully", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } + "type": "boolean" } } - } - }, - "delete": { - "tags": [ - "JobQueue" ], - "summary": "Delete specified jobs.", - "operationId": "DeleteJobs", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "application/*+json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 11": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 12": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 13": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 14": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 15": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 16": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 17": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 18": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 19": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 20": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } - } - } - }, - "422": { - "description": "No job IDs were specified" + } + } }, - "500": { - "description": "Failed to delete one or more jobs" + "404": { + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/job-queue/jobs/{id}": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}": { "get": { "tags": [ - "JobQueue" + "Data" ], - "summary": "Get job by ID.", - "operationId": "GetJob", + "summary": "Get a datum for a given database, record history, record version and attribute.", + "operationId": "GetDatumForVersion", "parameters": [ { - "name": "id", + "name": "database-key", "in": "path", - "description": "", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } + "type": "string" } }, - "404": { - "description": "Job not found" - } - } - }, - "patch": { - "tags": [ - "JobQueue" - ], - "summary": "Update a job.", - "operationId": "UpdateJob", - "parameters": [ { - "name": "id", + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateJobRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } - } }, - "404": { - "description": "Job not found" - } - } - }, - "delete": { - "tags": [ - "JobQueue" - ], - "summary": "Delete a job.", - "operationId": "DeleteJob", - "parameters": [ { - "name": "id", + "name": "record-version-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "Success - no content" }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:retrieve-definition": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get a job creation object based on an existing job.", - "operationId": "RestoreJob", - "parameters": [ { - "name": "id", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateJobRequest" - } - } - } }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:move-to-top": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Move a job to the top of the queue (actually sets the scheduled execution date to now, could be done with patch method).", - "operationId": "MoveToTop", - "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK" }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}:resubmit": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Resubmit a job.", - "operationId": "Resubmit", - "parameters": [ { - "name": "id", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaResubmitJobRequest" - } + "enum": [ + "read", + "write" + ], + "type": "string" } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaJob" - } - } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" } }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/files": { - "post": { - "tags": [ - "JobQueue" - ], - "summary": "Uploads an ephemeral file and returns an ID which can subsequently be used to refer to that file in a job creation request. Ephemeral files have a short lifespan\r\nand should be used to provide file data to jobs only. They should not be used as file storage.", - "operationId": "UploadFile", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } - } - }, - "encoding": { - "file": { - "style": "form" - } - } + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" } } - }, + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, "application/json": { "schema": { - "type": "string" - } - }, - "text/json": { - "schema": { - "type": "string" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 21": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 22": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 23": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 24": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 25": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 26": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 27": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 28": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 29": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 30": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } + } } } } + }, + "404": { + "description": "Database, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/job-queue/jobs/{id}/outputs": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}": { "get": { "tags": [ - "JobQueue" + "Data" ], - "summary": "Get a job's output filenames.", - "operationId": "GetOutputFilenames", + "summary": "Get a datum for a given attribute and the latest version of a record history in given database.", + "operationId": "GetDatumForLatest", "parameters": [ { - "name": "id", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } }, - "404": { - "description": "Job not found" - } - } - } - }, - "/v1alpha/job-queue/jobs/{id}/outputs:export": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Retrieve a job output file.", - "operationId": "GetJobOutputFile", - "parameters": [ { - "name": "id", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -25826,484 +5181,673 @@ } }, { - "name": "fileName", + "name": "mode", "in": "query", - "required": true, + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { + "enum": [ + "read", + "write" + ], "type": "string" } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } }, - "404": { - "description": "Job or file not found" - } - } - } - }, - "/v1alpha/job-queue/current-user": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get the current user.", - "operationId": "GetCurrentUser", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCurrentUser" - } - } + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } - } - } - } - }, - "/v1alpha/job-queue/processing-configuration": { - "get": { - "tags": [ - "JobQueue" - ], - "summary": "Get the processing configuration.", - "operationId": "GetProcessingConfig", - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaProcessingConfig" - } - } + }, + { + "name": "filterEmptyCells", + "in": "query", + "schema": { + "type": "boolean" } - } - } - } - }, - "/v1alpha/license/user-license:ensure-checked-out": { - "get": { - "tags": [ - "License" - ], - "summary": "Either checks out a user license for the requesting user, or returns an error response if no such license is available.\r\nThis method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter", - "operationId": "EnsureUserLicenseAvailable", - "responses": { - "200": { - "description": "Ok" }, - "403": { - "description": "Forbidden", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - } + { + "name": "filterEmptyRows", + "in": "query", + "schema": { + "type": "boolean" } } - } - } - }, - "/v1alpha/license/advanced-selection-license:ensure-checked-out": { - "get": { - "tags": [ - "License" ], - "summary": "Determines whether the requesting user has an Advanced Selection license available.\r\nIf a user has a license available this will be checked out.", - "operationId": "EnsureAdvancedSelectionLicenseAvailable", "responses": { "200": { - "description": "OK" - }, - "403": { - "description": "Forbidden", + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" - } - } - } - } - } - } - }, - "/v1alpha/license/server-licenses:ensure-checked-out": { - "post": { - "tags": [ - "License" - ], - "summary": "Checks out server wide licenses and returns a bool for each provided app name indicating if\r\nthe relevant license(s) required have been checked out.", - "operationId": "CheckoutAppLicense", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "MI BoM Analyzer" - ] - } - }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "MI BoM Analyzer" - ] - } - }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "MI BoM Analyzer" - ] - } - }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" - }, - "examples": { - "Example 1": { - "summary": "License request", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "MI BoM Analyzer" - ] - } + "$ref": "#/components/schemas/GsaDatum" }, - "Example 2": { - "summary": "License request with multiple application names", - "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", - "value": { - "appNames": [ - "RS Reports", - "Sustainability Analytics" - ] + "examples": { + "Example 31": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 32": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + }, + "Example 33": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" + } + }, + "Example 34": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 35": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 36": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 37": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 38": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 39": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 40": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } } } } } + }, + "404": { + "description": "Database, record history, attribute or datum not found" } - }, + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { + "get": { + "tags": [ + "Data" + ], + "summary": "Get the binary data for a given database, table, record history, record version and attribute. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + "type": "string", + "format": "binary" } } } + }, + "400": { + "description": "Attribute is not an exportable type" + }, + "404": { + "description": "Database, table, record history, record version, attribute or datum not found" } } } }, - "/v1alpha/license/server-licenses": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { "get": { "tags": [ - "License" + "Data" + ], + "summary": "Get the binary data for a given attribute and the latest version of a record history in given database and table. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } ], - "summary": "Get info on which server licenses are enabled, and the license expiry date.", - "operationId": "GetServerLicense", "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + "type": "string", + "format": "binary" } } } + }, + "400": { + "description": "Attribute is not an exportable type" + }, + "404": { + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/api/v1/lists/audit/search": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}:export": { + "get": { "tags": [ - "ListAuditLog" + "Data" ], - "summary": "Posts a search request, and returns an object containing search result identifier", - "operationId": "RunListAuditLogSearch", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", - "value": { - "listIdentifiers": [ - "11f5c015-c6a1-4a6c-bd1f-fb4625efd12b" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", - "value": { - "listIdentifiers": [ - "11f5c015-c6a1-4a6c-bd1f-fb4625efd12b" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", - "value": { - "listIdentifiers": [ - "11f5c015-c6a1-4a6c-bd1f-fb4625efd12b" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" - }, - "examples": { - "Example 1": { - "summary": "Record list audit log search", - "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", - "value": { - "listIdentifiers": [ - "11f5c015-c6a1-4a6c-bd1f-fb4625efd12b" - ], - "listActionsToInclude": [ - "ItemAdded", - "ItemRemoved" - ], - "pagingOptions": { - "startIndex": 0, - "pageSize": 10 - } - } - } - } + "summary": "Get the binary data for a given database, record history, record version and attribute. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" } } - }, + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" + "type": "string", + "format": "binary" } } } }, "400": { - "description": "Bad request" + "description": "Attribute is not an exportable type" }, - "403": { - "description": "Forbidden" + "404": { + "description": "Database, record history, record version, attribute or datum not found" } } } }, - "/api/v1/lists/audit/search/results/{resultResourceIdentifier}": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}:export": { "get": { "tags": [ - "ListAuditLog" + "Data" ], - "summary": "Returns the search results found in the specified resource", - "operationId": "GetListAuditLogSearchResults", + "summary": "Get the binary data for a given attribute and the latest version of a record history in given database. Must be a file or picture attribute.", + "operationId": "ExportBinaryDataForLatest", "parameters": [ { - "name": "resultResourceIdentifier", - "in": "path", - "required": true, + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", "schema": { - "type": "string", - "format": "uuid" + "type": "integer", + "format": "int32" } } ], @@ -26311,759 +5855,629 @@ "200": { "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" - } + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaListAuditLogItem" - } + "type": "string", + "format": "binary" } } } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Attribute is not an exportable type" }, "404": { - "description": "Search result not found" - }, - "410": { - "description": "Search result no longer available" + "description": "Database, record history, attribute or datum not found" } } } }, - "/api/v1/lists/list/{listIdentifier}/items": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { "get": { "tags": [ - "ListItem" + "Data" ], - "summary": "Returns the items in the given list", - "operationId": "GetListItems", + "summary": "Get a datum for a given database, table, record history, record version, tabular attribute, row and column.", + "operationId": "GetCellDatumForVersionFromTable", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - } - } - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/items/add": { - "post": { - "tags": [ - "ListItem" - ], - "summary": "Adds the specified items to an existing list.", - "operationId": "AddItemsToList", - "parameters": [ { - "name": "listIdentifier", + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request" + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "403": { - "description": "Forbidden" + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/items/remove": { - "post": { - "tags": [ - "ListItem" - ], - "summary": "Removed the specified items from an existing list.", - "operationId": "RemoveItemsFromList", - "parameters": [ { - "name": "listIdentifier", + "name": "column-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDeleteRecordListItems" - } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListItemsInfo" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 2": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + } } } } }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Record list not found" + "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" } } } }, - "/api/v1/lists": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Returns all lists visible to the calling user", - "operationId": "GetAllLists", - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeadersInfo" - } - } + "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database and table.", + "operationId": "GetCellDatumForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "403": { - "description": "Forbidden" - } - } - }, - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Creates a new list with the specified properties and items.", - "operationId": "CreateList", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordList" - } + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request" + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "403": { - "description": "Forbidden" - } - } - } - }, - "/api/v1/lists/search": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Posts a search request, and returns an object containing search result identifier", - "operationId": "RunRecordListsSearch", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchRequest" - } + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchInfo" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 3": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 4": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + } } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history, tabular attribute, row, column or datum not found" } } } }, - "/api/v1/lists/search/results/{resultResourceIdentifier}": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Returns the search results found in the specified resource", - "operationId": "GetRecordListSearchResults", + "summary": "Get a datum for a given database, record history, record version, tabular attribute, row and column.", + "operationId": "GetCellDatumForVersion", "parameters": [ { - "name": "resultResourceIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 5": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Search result not found" - }, - "410": { - "description": "Search result no longer available" + "description": "Database, record history, record version, tabular attribute, row, column or datum not found" } } } }, - "/api/v1/lists/list/{listIdentifier}": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Returns the given list if it exists and the calling user has read access to it", - "operationId": "GetList", + "summary": "Get a datum for a given tabular attribute, row and column and the latest version of a record history in given database.", + "operationId": "GetCellDatumForLatest", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "403": { - "description": "Forbidden" + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Record list not found" - } - } - }, - "patch": { - "tags": [ - "ListManagement" - ], - "summary": "Performs a partial update on the properties of a list.", - "operationId": "UpdateList", - "parameters": [ { - "name": "listIdentifier", + "name": "column-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", - "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false - } - }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", - "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", - "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false - } - }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", - "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", - "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false - } - }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", - "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListProperties" - }, - "examples": { - "Example 1": { - "summary": "Update the name of list", - "description": "Update the name of a list", - "value": { - "name": "new name", - "published": false, - "awaitingApproval": false, - "internalUse": false - } - }, - "Example 2": { - "summary": "Update everything for a list", - "description": "Update everything for a list", - "value": { - "name": "new name", - "description": "new description", - "notes": "new notes", - "published": false, - "awaitingApproval": true, - "internalUse": true - } - } - } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } - }, + ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "$ref": "#/components/schemas/GsaDatum" + }, + "examples": { + "Example 7": { + "summary": "Integer cell datum.", + "description": "Example response for an integer cell datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } + }, + "Example 8": { + "summary": "Logical cell datum.", + "description": "Example response for a logical cell datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } + } } } } }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Record list not found" + "description": "Database, record history, tabular attribute, row, column or datum not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Delete an existing list.", - "operationId": "DeleteList", + "summary": "Get the binary data for a given database, table, record history, record version, tabular attribute, row and column. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForVersionFromTable", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok" }, - "403": { - "description": "Forbidden" + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/request-approval": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to \"awaiting approval\".", - "operationId": "RequestApproval", - "parameters": [ { - "name": "listIdentifier", + "name": "record-version-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request" + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "403": { - "description": "Forbidden" + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/reset": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to not be \"awaiting approval\".", - "operationId": "ResetAwaitingApproval", - "parameters": [ { - "name": "listIdentifier", - "in": "path", - "required": true, + "name": "maxWidth", + "in": "query", "schema": { - "type": "string", - "format": "uuid" + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" } } ], @@ -27071,472 +6485,323 @@ "200": { "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "type": "string", + "format": "binary" } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Column is not an exportable type" }, "404": { - "description": "Record list not found" + "description": "Database, table, record history, record version, tabular attribute, row, column or datum not found" } } } }, - "/api/v1/lists/list/{listIdentifier}/publish": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Update the status of an existing list to \"published\". The list must be awaiting approval, and not already published.\r\nThe \"awaiting approval\" flag will be reset to false.", - "operationId": "PublishList", + "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database and table. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForLatestFromTable", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request" + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "403": { - "description": "Forbidden" + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/unpublish": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Update the status of an existing list to \"unpublished\". The list must be published, and awaiting approval.\r\nThe \"awaiting approval\" flag will be reset to false.", - "operationId": "UnpublishList", - "parameters": [ { - "name": "listIdentifier", + "name": "column-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" + "type": "string", + "format": "binary" } } } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Column is not an exportable type" }, "404": { - "description": "Record list not found" + "description": "Database, table, record history, tabular attribute, row, column or datum not found" } } } }, - "/api/v1/lists/list/{listIdentifier}/revise": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { "tags": [ - "ListManagement" + "Data" ], - "summary": "Creates a private copy of a list that can be revised.", - "operationId": "ReviseList", + "summary": "Get the binary data for a given database, record history, record version, tabular attribute, row and column. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForVersion", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/copy": { - "post": { - "tags": [ - "ListManagement" - ], - "summary": "Creates a copy of the list and its items", - "operationId": "CopyList", - "parameters": [ { - "name": "listIdentifier", + "name": "record-version-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListHeader" - } - } - } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions/subscribe": { - "post": { - "tags": [ - "ListPermissions" - ], - "summary": "Subscribes the calling user to the specified list.", - "operationId": "Subscribe", - "parameters": [ { - "name": "listIdentifier", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - } - } - }, - "400": { - "description": "Bad request" }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions/unsubscribe": { - "post": { - "tags": [ - "ListPermissions" - ], - "summary": "Unsubscribes the calling user from the specified list.", - "operationId": "Unsubscribe", - "parameters": [ { - "name": "listIdentifier", + "name": "row-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermission" - } - } - } - }, - "400": { - "description": "Bad request" }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list not found" - }, - "422": { - "description": "Unsubscribe Failed" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions": { - "get": { - "tags": [ - "ListPermissions" - ], - "summary": "Gets all permissions associated with the specified list.", - "operationId": "GetPermissions", - "parameters": [ { - "name": "listIdentifier", + "name": "column-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" + "type": "string", + "format": "binary" } } } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Column is not an exportable type" }, "404": { - "description": "Record list not found" + "description": "Database, record history, record version, tabular attribute, row, column or datum not found" } } - }, - "post": { + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:export": { + "get": { "tags": [ - "ListPermissions" + "Data" ], - "summary": "Sets permissions for the specified list. Returns a collection of the created/updated permissions.", - "operationId": "SetPermissions", + "summary": "Get the binary data for a given tabular attribute, row and column and the latest version of a record history in given database. Must be a file or picture column.", + "operationId": "ExportCellBinaryDataForLatest", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUserPermissionsInfo" - } - } + "type": "string" } }, - "400": { - "description": "Bad request" + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "403": { - "description": "Forbidden" + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "404": { - "description": "Record list or user or group not found" - } - } - } - }, - "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": { - "get": { - "tags": [ - "ListPermissions" - ], - "summary": "Gets the permission flags of the permission associating the specified list with the specified user.", - "operationId": "GetPermissionsForUser", - "parameters": [ { - "name": "listIdentifier", + "name": "row-guid", "in": "path", "required": true, "schema": { @@ -27545,53 +6810,100 @@ } }, { - "name": "userIdentifier", + "name": "column-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "maxWidth", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "maxHeight", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + "type": "string", + "format": "binary" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + "type": "string", + "format": "binary" } } } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Column is not an exportable type" }, "404": { - "description": "User or group, record list or record list permission not found" + "description": "Database, record history, tabular attribute, row, column or datum not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { "put": { "tags": [ - "ListPermissions" + "Data" ], - "summary": "Sets the permission flags of the permission associating the specified list with the specified user.", - "operationId": "SetPermissionsForUser", + "summary": "Create or edit a datum for a given attribute and record history in a given database and table.", + "operationId": "SetDatumForAttributeFromTable", "parameters": [ { - "name": "listIdentifier", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -27600,7 +6912,16 @@ } }, { - "name": "userIdentifier", + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -27613,1099 +6934,1142 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3465534+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3465534+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordListPermissionFlags" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Record list or user or group not found" - } - } - } - }, - "/v1alpha/metrics/jobs": { - "get": { - "tags": [ - "Metrics" - ], - "summary": "Get a summary of jobs currently running or completed since the start time.", - "operationId": "GetJobsSummary", - "parameters": [ - { - "name": "start", - "in": "query", - "description": "The number of System.DateTime.Ticks that represent the UTC start time.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } + "$ref": "#/components/schemas/GsaSetDatum" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" - } - } - } - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for the latest version of a given record history in a given table for a given record link group.", - "operationId": "GetLinkResultsForGroupForHistoryFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "490615a4-3a69-4622-a28a-f19cab06ff0b" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "96e54b55-308b-47ac-af47-554ad105c4ee" - } - } - ] - } - }, - "Example 2": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } } - } - ] + ] + } + ] + } + }, + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3465534+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } - }, - "Example 3": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 1": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } + }, + "Example 2": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 5": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 6": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 7": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 8": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 9": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } } - } - ] - } - }, - "Example 4": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "51516872-bbde-4dc0-b8e9-9ec5415774b0" + ] }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "8f38eff4-3495-4f7d-85b8-70143c3fad9a" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "764359b7-6624-449b-b1d6-d59dfb422f75" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "2576f532-0500-44a0-9dea-eb9aa7cb0f3f" + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } } - } - ] - } + ] + } + ] } - } - } - } - }, - "404": { - "description": "Database, table, record history or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for the latest version of a given record history for a given record link group", - "operationId": "GetLinkResultsForGroupForHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" }, - "examples": { - "Example 5": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "2c8a2664-e32f-4684-a600-225100da04fe" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "c41349be-9420-4830-a496-72817587dab3" - } - } - ] + "Example 10": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3465534+00:00" + } + }, + "Example 11": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 12": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } - }, - "Example 6": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 13": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] - } - }, - "Example 7": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 14": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" - } - } - ] - } - }, - "Example 8": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "56c1fa7c-890d-4687-8492-a534cc91a148" + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "09cac96d-e69e-4f64-ac40-206ce54e46e1" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "66964a27-520f-4634-aba6-50e70ec8bd0e" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "aa6c741d-ff8f-46ce-b47c-eaf046004a6a" - } - } - ] - } + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] } } } } - }, - "404": { - "description": "Database, record history or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for a given record version in a given table and record history for a given record link group", - "operationId": "GetLinkResultsForGroupForVersionFromTable", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } - ], + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" + "$ref": "#/components/schemas/GsaDatum" }, "examples": { - "Example 9": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "Example 1": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "eae4965a-5f1c-465f-a4d8-ca35755174ff" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "7c88873c-7ae8-455d-9f49-1ee2d49883ab" - } - } - ] + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" } }, - "Example 10": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", + "Example 2": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] + "datumType": "logical", + "value": true, + "notApplicable": "applicable" } }, - "Example 11": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "Example 3": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" - } - } - ] + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" } }, - "Example 12": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", - "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "a826e28f-9f29-439b-9257-9e1bdaaf72d7" - }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "3aa09f48-1d48-4d76-85b1-f138ad376c6f" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "929205ca-08ee-4710-99d7-003d26b56cc3" - } - }, - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "f3a6db1f-d248-4cfb-840b-6138240cc021" - } - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database, table, record history, record version or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/record-link-results/{record-link-group-guid}/{record-link-group-type}": { - "get": { - "tags": [ - "Record Links" - ], - "summary": "Get record link results for a given record version of a given record history for a given record link group", - "operationId": "GetLinkResultsForGroupForVersion", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "record-history-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-version-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkResults" - }, - "examples": { - "Example 13": { - "summary": "Static record link group", - "description": "This example demonstrates getting record link results for the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "Example 4": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", "value": { - "recordLinkGroup": { - "type": "static", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" }, - "results": [ - { - "recordLinkGroupType": "static", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Indirectly linked record", - "guid": "6eef10ae-f7d7-4a26-9429-0440d0efc4a5" - } - }, - { - "recordLinkGroupType": "static", - "notes": "Link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Directly linked record", - "guid": "c354fb19-d5c8-48b2-bbf7-07da51501ee1" - } - } - ] + "notApplicable": "applicable" } }, - "Example 14": { - "summary": "Smart record link group - records linked to 'target' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Ti (Titanium)' record (GUID = 'b36334e1-8efe-483b-9f62-e559f015664e') in the 'Training Exercise for Import' table (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from MI_Training database.", + "Example 5": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 6": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 7": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "results": [ - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, aged", - "guid": "00001192-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, annealed generic", - "guid": "00001194-000e-4fff-8fff-dd92ffff0000" - } - }, - { - "recordLinkGroupType": "smart", - "isLinkToTarget": true, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Titanium, alpha-beta alloy, Ti-6Al-4V, solution treated & aged", - "guid": "0000119b-000e-4fff-8fff-dd92ffff0000" - } - } - ] + "notApplicable": "applicable" } }, - "Example 15": { - "summary": "Smart record link group - records linked to 'source' record", - "description": "This example demonstrates getting record link results for the 'Smart Link to MaterialUniverse' smart link group (GUID = '7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66') for the 'Titanium, alpha-beta alloy, Ti-6Al-4V, aged' record (GUID = '00001192-000e-4fff-8fff-dd92ffff0000') in the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "Example 8": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", "value": { - "recordLinkGroup": { - "type": "smart", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "results": [ + "notApplicable": "applicable" + } + }, + "Example 9": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ { - "recordLinkGroupType": "smart", - "isLinkToTarget": false, - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Ti (Titanium)", - "guid": "b36334e1-8efe-483b-9f62-e559f015664e" + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" } } - ] + ], + "notApplicable": "applicable" } }, - "Example 16": { - "summary": "Cross database record link group", - "description": "This example demonstrates getting record link results for a cross database record link group.", + "Example 10": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", "value": { - "recordLinkGroup": { - "type": "crossDatabase", - "guid": "3a42c06d-2f56-48a9-9050-a92af1196b86" - }, - "results": [ - { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record A", - "guid": "443ccd49-aee2-4e20-8ad6-59abddf604d5" - } - }, + "datumType": "point", + "estimated": false, + "values": [ { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_1", - "notes": "Cross database link notes", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record B", - "guid": "ec9dcc2b-e9af-45fb-99d9-bd1ae19d762b" - } + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] }, { - "recordLinkGroupType": "crossDatabase", - "linkedDatabaseKey": "Linked_Database_Key_2", - "linkedRecord": { - "versionNumber": 0, - "versionState": "unversioned", - "name": "Target Record X", - "guid": "27faa06e-89e3-4bc3-a9bb-c5991adae391" - } + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ] + ], + "notApplicable": "applicable" } } } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, record history, record version or record link group not found" + "description": "Database, table, record history or attribute not found" + }, + "422": { + "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}": { - "get": { + }, + "delete": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Get a record history with a specified guid for a given database and table.", - "operationId": "GetRecordHistoryFromTable", + "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database and table.", + "operationId": "DeleteDatumForAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -28719,93 +8083,42 @@ } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } + "description": "Ok" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table or record history not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}": { + "put": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Get a record history with a specified guid for a given database.", - "operationId": "GetRecordHistory", + "summary": "Create or edit a datum for a given attribute and record history in a given database.", + "operationId": "SetDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -28818,433 +8131,1203 @@ } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSetDatum" + }, + "examples": { + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", + "value": { + "setDatumType": "integer", + "value": 34 + } }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] + } + }, + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3715552+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } } - } - }, - "404": { - "description": "Database or record history not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories": { - "post": { - "tags": [ - "Records - Record Histories" - ], - "summary": "Create a new record history.", - "operationId": "CreateRecordHistory", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { + }, + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "recordType": "record", - "name": "New Record Name" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "53c2660c-10bf-4f9c-a178-41affd5c5eb5" + "setDatumType": "shortText", + "value": "TResistant to strong acid" } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3715552+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "recordType": "record", - "name": "New Record Name" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "53c2660c-10bf-4f9c-a178-41affd5c5eb5" + "setDatumType": "shortText", + "value": "TResistant to strong acid" } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] + } + }, + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3715552+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 15": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer datum.", "value": { - "recordType": "record", - "name": "New Record Name" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 16": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical datum.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 17": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text datum.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "53c2660c-10bf-4f9c-a178-41affd5c5eb5" + "setDatumType": "shortText", + "value": "TResistant to strong acid" } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 18": { + "summary": "Discrete datum - single valued", + "description": "This example demonstrates how to set the value for a discrete datum for attribute 'Metals' (GUID = '0000000b-0001-4fff-8fff-dd92ffff0000') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "00000583-0007-4fff-8fff-0083ffff0000" + } + ] } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 19": { + "summary": "Discrete datum - multi valued", + "description": "This example demonstrates how to set multiple values for a discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "setDatumType": "discrete", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateRecordHistory" - }, - "examples": { - "Example 1": { - "summary": "Record History", - "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + }, + "Example 20": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range datum with values in database units.", "value": { - "recordType": "record", - "name": "New Record Name" + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false } }, - "Example 2": { - "summary": "Record History with Tree Name and Parent", - "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 21": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range datum with values in database units and the upper range unbounded.", "value": { - "recordType": "record", - "name": "Alumino Silicate - 1756", - "shortName": "1756", - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false } }, - "Example 3": { - "summary": "Record History for a 'folder' with specified guid", - "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 22": { + "summary": "Point datum - single valued", + "description": "This example demonstrates how to set the value for a single valued point datum with a value in database units.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "guid": "53c2660c-10bf-4f9c-a178-41affd5c5eb5" + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] } }, - "Example 4": { - "summary": "Record History with specified color", - "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 23": { + "summary": "Point datum - multi valued with parameters", + "description": "This example demonstrates how to set the values for a multi valued point datum with parameters. All values are taken to be in database units.", "value": { - "recordType": "folder", - "name": "Borosilicate", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordColor": "lime" + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.26, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.16 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.31, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.56 + } + }, + { + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ] } }, - "Example 5": { - "summary": "Record History for a 'generic'", - "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "Example 24": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime datum.", "value": { - "recordType": "generic", - "name": "Soda-zinc", - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3715552+00:00" + } + }, + "Example 25": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 26": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" } } + }, + "Example 27": { + "summary": "Tabular datum", + "description": "This example demonstrates how to set the value for a Tabular datum for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Alumino silicate - 1720' (Record History GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'. Specific cell datums can be set via per cell datum endpoints.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "linkingValue": "85535-84-8" + }, + { + "linkingValue": "1327-53-3" + } + ] + } + }, + "Example 28": { + "summary": "Tabular datum - rows reordering", + "description": "This example demonstrates how to update the value for a Tabular datum reordering its rows for attribute 'Restricted substances associated with this material' (GUID = '51e51832-0bcc-4fe0-bb95-ddd6917dc554') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "setDatumType": "tabular", + "rows": [ + { + "guid": "d7438ba7-7233-4429-be8b-0d5e03e5903c", + "linkingValue": "85535-84-8" + }, + { + "guid": "58ab44e2-23d2-42ef-9749-2da1fd542f9b", + "linkingValue": "84-74-2" + }, + { + "guid": "cc775763-3986-4ba6-8722-45b3940c5269", + "linkingValue": "117-81-7" + } + ] + } } } } } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" + "$ref": "#/components/schemas/GsaDatum" }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "examples": { + "Example 11": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } }, - "parent": { - "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + "Example 12": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "New Alumino Silicate Record", - "guid": "d2aa7ff8-f7d1-448e-b60c-0753bd2828c3" + "Example 13": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" } - ], - "subsets": [], - "guid": "79b93506-4549-4f2b-975b-dcdb871f8a79" + }, + "Example 14": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" + } + }, + "Example 15": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", + "value": { + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 16": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 17": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 18": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 19": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } + } + ], + "notApplicable": "applicable" + } + }, + "Example 20": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", + "value": { + "datumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] + } + ], + "notApplicable": "applicable" + } + } } } } }, - "400": { - "description": "Bad request" + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history or attribute not found" + }, + "422": { + "description": "Validation of the data value fails e.g. for integer data where the attribute is marked as having unique values." + } + } + }, + "delete": { + "tags": [ + "Data" + ], + "summary": "Deletes a datum for a given attribute and record history, along with all meta attributes datums associated with it, in a given database.", + "operationId": "DeleteDatumForAttribute", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:move": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "put": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Move a record history to be under a new parent.", - "operationId": "MoveRecordHistoryInTable", + "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -29256,91 +9339,422 @@ "type": "string", "format": "uuid" } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "setDatumType": "integer", + "value": 34 } }, "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3795513+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "setDatumType": "integer", + "value": 34 } }, "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3795513+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "setDatumType": "integer", + "value": 34 } }, "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3795513+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { "Example 1": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } + "setDatumType": "integer", + "value": 34 } }, "Example 2": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", + "value": { + "setDatumType": "logical", + "value": true + } + }, + "Example 3": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", + "value": { + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 4": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 5": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 6": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 7": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3795513+00:00" + } + }, + "Example 8": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 9": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } + } } } } @@ -29352,143 +9766,242 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" + "$ref": "#/components/schemas/GsaDatum" }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "examples": { + "Example 21": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "Example 22": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "Example 23": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + }, + "Example 24": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryMoveException" - }, - "examples": { - "Example 1": { - "summary": "New parent is not a folder.", + }, + "Example 25": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", "value": { - "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder" - } - ] + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" + } + }, + "Example 26": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", + "value": { + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" + } + }, + "Example 27": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", + "value": { + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" } }, - "Example 2": { - "summary": "New parent is not in the same table.", + "Example 28": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", "value": { - "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", - "reason": "ParentNotInSameTable" - } - ] + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" } }, - "Example 3": { - "summary": "The 'short name' of the record to be moved is not unique under the new parent.", + "Example 29": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", "value": { - "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryMove", - "errors": [ + "datumType": "point", + "estimated": false, + "values": [ { - "message": "A record with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder" + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } } - ] + ], + "notApplicable": "applicable" } }, - "Example 4": { - "summary": "New parent is withdrawn.", + "Example 30": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", "value": { - "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryMove", - "errors": [ + "datumType": "point", + "estimated": false, + "values": [ { - "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn" - } - ] - } - }, - "Example 5": { - "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", - "value": { - "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", - "code": "recordHistoryMove", - "errors": [ + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, { - "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", - "reason": "ParentIsADescendant" + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ] + ], + "notApplicable": "applicable" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or record history not found" + "description": "Database, table, record history, tabular attribute, row or column not found" } } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:move": { - "post": { + }, + "delete": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Move a record history to be under a new parent.", - "operationId": "MoveRecordHistory", + "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "DeleteCellDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -29499,254 +10012,93 @@ "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } - } - }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } - } - }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } - } - }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveRecordHistory" - }, - "examples": { - "Example 3": { - "summary": "Move Record History", - "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - } - } - }, - "Example 4": { - "summary": "Move Record History to be directly under the Table.", - "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": {} - } - } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - } - } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryMoveException" - }, - "examples": { - "Example 6": { - "summary": "New parent is not a folder.", - "value": { - "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder" - } - ] - } - }, - "Example 7": { - "summary": "New parent is not in the same table.", - "value": { - "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", - "reason": "ParentNotInSameTable" - } - ] - } - }, - "Example 8": { - "summary": "The 'short name' of the record to be moved is not unique under the new parent.", - "value": { - "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "A record with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder" - } - ] - } - }, - "Example 9": { - "summary": "New parent is withdrawn.", - "value": { - "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn" - } - ] - } - }, - "Example 10": { - "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", - "value": { - "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", - "code": "recordHistoryMove", - "errors": [ - { - "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", - "reason": "ParentIsADescendant" - } - ] - } - } - } - } + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or record history not found" + "description": "Database, table, record history, tabular attribute, row, column or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:copy": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}": { + "put": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Make a copy of a record history.", - "operationId": "CopyRecordHistoryInTable", + "summary": "Create or edit a cell datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", "in": "path", "required": true, "schema": { @@ -29759,144 +10111,388 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3846852+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3846852+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3846852+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" + "$ref": "#/components/schemas/GsaSetDatum" }, "examples": { - "Example 1": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 10": { + "summary": "Integer datum", + "description": "This example demonstrates how to set the value for an integer cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" + "setDatumType": "integer", + "value": 34 } }, - "Example 2": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 11": { + "summary": "Logical datum", + "description": "This example demonstrates how to set the value for a logical cell datum.", "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" + "setDatumType": "logical", + "value": true } }, - "Example 3": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "Example 12": { + "summary": "Short text datum", + "description": "This example demonstrates how to set the value for a short text cell datum.", "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" + "setDatumType": "shortText", + "value": "TResistant to strong acid" + } + }, + "Example 13": { + "summary": "Range datum", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units.", + "value": { + "setDatumType": "range", + "lowValue": 27.3, + "highValue": 31.2, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false + } + }, + "Example 14": { + "summary": "Range datum with upper range unbounded", + "description": "This example demonstrates how to set the value for a range cell datum with values in database units and the upper range unbounded.", + "value": { + "setDatumType": "range", + "lowValue": 750.0, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false + } + }, + "Example 15": { + "summary": "Point datum", + "description": "This example demonstrates how to set the value for a point cell datum with a value in database units.", + "value": { + "setDatumType": "point", + "estimated": false, + "values": [ + { + "pointValue": 12.7 + } + ] + } + }, + "Example 16": { + "summary": "DateTime datum", + "description": "This example demonstrates how to set the value for a DateTime cell datum.", + "value": { + "setDatumType": "datetime", + "value": "2026-04-04T03:40:14.3846852+00:00" + } + }, + "Example 17": { + "summary": "Hyperlink datum", + "description": "This example demonstrates how to set the value for a Hyperlink cell datum.", + "value": { + "setDatumType": "hyperLink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow" + } + }, + "Example 18": { + "summary": "Long Text datum", + "description": "This example demonstrates how to set the value for a Long Text cell datum.", + "value": { + "setDatumType": "longText", + "richTextValue": { + "text": "Debug Text", + "type": "plain" + } } } } @@ -29904,135 +10500,238 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" + "$ref": "#/components/schemas/GsaDatum" }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "examples": { + "Example 31": { + "summary": "Integer datum.", + "description": "Example response for an integer datum with a value of 7.", + "value": { + "datumType": "integer", + "value": 7, + "notApplicable": "applicable" + } }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + "Example 32": { + "summary": "Logical datum.", + "description": "Example response for a logical datum with a value of 'true'", + "value": { + "datumType": "logical", + "value": true, + "notApplicable": "applicable" + } }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "Example 33": { + "summary": "Short Text datum.", + "description": "Example response for a short text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "shortText", + "value": "Resistant to strong acid", + "notApplicable": "applicable" } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + }, + "Example 34": { + "summary": "Long Text datum.", + "description": "Example response for a long text datum with a value of 'Resistant to strong acid'", + "value": { + "datumType": "longText", + "richTextValue": { + "text": "Resistant to strong acid", + "type": "plain" + }, + "notApplicable": "applicable" } - ], - "guid": "74dbe525-84a9-4c30-b2ef-e4eece3af91d" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryCopyException" - }, - "examples": { - "Example 1": { - "summary": "New parent is not a folder.", + }, + "Example 35": { + "summary": "Hyperlink datum.", + "description": "Example response for a hyperlink datum with a value of localhost", "value": { - "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder" - } - ] + "datumType": "hyperlink", + "address": "http://localhost", + "description": "local host", + "target": "newWindow", + "notApplicable": "applicable" } }, - "Example 2": { - "summary": "New parent is not in the same table.", + "Example 36": { + "summary": "DateTime datum.", + "description": "Example response for a DateTime datum with a value of January 1st, 2000", "value": { - "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", - "reason": "ParentNotInSameTable" - } - ] + "datumType": "dateTime", + "dateTime": "2000-01-01T00:00:00+00:00", + "notApplicable": "applicable" } }, - "Example 3": { - "summary": "The 'short name' of the record to be copied is not unique under the new parent.", + "Example 37": { + "summary": "Range datum.", + "description": "Example response for a range datum with both low and high range values set", "value": { - "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryCopy", - "errors": [ + "datumType": "range", + "lowValue": 1200.0, + "highValue": 1275.0, + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 38": { + "summary": "Range datum - low bound only.", + "description": "Example response for a range datum with only the low range value set", + "value": { + "datumType": "range", + "lowValue": 1.75, + "highValue": "NaN", + "lowValueIsInclusive": false, + "highValueIsInclusive": false, + "estimated": false, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "notApplicable": "applicable" + } + }, + "Example 39": { + "summary": "Point datum - single valued.", + "description": "Example response for a single valued point datum", + "value": { + "datumType": "point", + "estimated": false, + "values": [ { - "message": "A record with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder" + "pointValue": 12.7, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + } } - ] + ], + "notApplicable": "applicable" } }, - "Example 4": { - "summary": "New parent is withdrawn.", + "Example 40": { + "summary": "Point datum - multi valued with parameters.", + "description": "Example response for a multi valued point datum with parameters", "value": { - "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryCopy", - "errors": [ + "datumType": "point", + "estimated": false, + "values": [ { - "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn" + "pointValue": 1.2, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 273.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Weak acids", + "guid": "877e2141-2f1b-4cd5-b5ec-6664c20fac9c" + } + } + } + ] + }, + { + "pointValue": 1.4, + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "parametersAndValues": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 303.16, + "unit": { + "symbol": "K", + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + } + } + }, + { + "parameter": { + "name": "Chemical Environment", + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + }, + "parameterDataValue": { + "parameterType": "discrete", + "parameterValue": { + "type": "discrete", + "name": "Strong acids", + "guid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + } + ] } - ] + ], + "notApplicable": "applicable" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or record history not found" + "description": "Database, record history, tabular attribute, row or column not found" } } - } - }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:copy": { - "post": { + }, + "delete": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Make a copy of a record history.", - "operationId": "CopyRecordHistory", + "summary": "Deletes a cell datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "DeleteCellDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -30043,296 +10742,70 @@ "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" - } - }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" - } - }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" - } - }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" - } - }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" - } - }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" - } - }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCopyRecordHistory" - }, - "examples": { - "Example 4": { - "summary": "Copy Record History - no name change - add new record to the new parent's subsets", - "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromParent" - } - }, - "Example 5": { - "summary": "Copy Record History - with name change - add new record to the original record's subsets", - "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "newParent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "subsetOption": "fromOriginalRecord", - "newShortName": "Short name for new record" - } - }, - "Example 6": { - "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", - "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", - "value": { - "subsetOption": "none", - "newShortName": "Short name for new record" - } - } - } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistory" - }, - "example": { - "isFolder": false, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "parent": { - "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" - }, - "recordVersions": [ - { - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" - } - ], - "subsets": [ - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - } - ], - "guid": "b0af7acc-01f2-4c2a-ab53-d577c5481cce" - } - } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordHistoryCopyException" - }, - "examples": { - "Example 5": { - "summary": "New parent is not a folder.", - "value": { - "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", - "reason": "ParentNotAFolder" - } - ] - } - }, - "Example 6": { - "summary": "New parent is not in the same table.", - "value": { - "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", - "reason": "ParentNotInSameTable" - } - ] - } - }, - "Example 7": { - "summary": "The 'short name' of the record to be copied is not unique under the new parent.", - "value": { - "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "A record with the short name 'Sheet' already exists in the parent folder.", - "reason": "ShortNameExistsInFolder" - } - ] - } - }, - "Example 8": { - "summary": "New parent is withdrawn.", - "value": { - "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", - "code": "recordHistoryCopy", - "errors": [ - { - "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", - "reason": "ParentIsWithdrawn" - } - ] - } - } - } - } + { + "name": "column-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or record history not found" + "description": "Database, record history, tabular attribute, row, column or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { + "put": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Get the latest record version for a record history for a given database and table.", - "operationId": "GetLatestRecordVersionFromTable", + "summary": "Create or edit a file datum for a given attribute and record history in a given database and table.", + "operationId": "SetFileDatumForAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -30346,97 +10819,94 @@ } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" + }, + "Description": { + "type": "string", + "description": "File description." + }, + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." + }, + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true - }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table or record history not found" + "description": "Database, table, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-file": { + "put": { "tags": [ - "Records - Record Histories" + "Data" ], - "summary": "Get the latest record version for a record history for a given database.", - "operationId": "GetLatestRecordVersion", + "summary": "Create or edit a file datum for a given attribute and record history in a given database.", + "operationId": "SetFileDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -30449,107 +10919,102 @@ } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "attribute-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "Description": { + "type": "string", + "description": "File description." }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or record history not found" + "description": "Database, record history or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Get a record version with a specified guid for a given database, table and record history.", - "operationId": "GetRecordVersion", + "summary": "Create or edit a picture datum for a given attribute and record history in a given database and table.", + "operationId": "SetPictureDatumForAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -30563,115 +11028,76 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Alumino silicate - 1720", - "recordColor": "fuchsia", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": false, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true - }, - "versionNumber": 1, - "versionState": "unversioned", - "name": "Alumino silicate - 1720", - "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + "$ref": "#/components/schemas/GsaPictureDatum" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table, record history or attribute not found" + }, + "415": { + "description": "Invalid image file" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:import-picture": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Deletes the record version. If the table is version controlled, only the current unreleased record version can be deleted.", - "operationId": "DeleteRecordVersion", + "summary": "Create or edit a picture datum for a given attribute and record history in a given database.", + "operationId": "SetPictureDatumForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { @@ -30684,7 +11110,7 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -30693,46 +11119,75 @@ } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { - "description": "Ok" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPictureDatum" + } + } + } }, "400": { - "description": "Bad request. Table is version controlled and record version is not unreleased." + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, record history or attribute not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:release": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Releases the record version. Must be an unreleased record version.", - "operationId": "ReleaseRecordVersion", + "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellFileDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -30746,7 +11201,25 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", "in": "path", "required": true, "schema": { @@ -30755,144 +11228,107 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + "Description": { + "type": "string", + "description": "File description." }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": false, - "canRelease": false, - "canGetModifiableVersion": true, - "canWithdraw": true, - "canDelete": false + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." }, - "versionNumber": 1, - "versionState": "released", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" } } } - }, - "400": { - "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.", + } + }, + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReleaseRecordVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "Only unreleased record versions can be released.", - "value": { - "message": "Cannot release record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "releaseRecordVersionControl", - "errors": [ - { - "message": "Invalid version state 'Released'.", - "reason": "invalidVersionState", - "versionState": "released" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot release record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "releaseRecordVersionControl", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } - }, - "Example 3": { - "summary": "Parent is not released.", - "value": { - "message": "Cannot release record version with GUID '7049425e-0f67-47e3-a944-64416c791bd7'.", - "code": "releaseRecordVersionControl", - "errors": [ - { - "message": "Tree parent is not in a valid state to perform this operation.", - "reason": "invalidParentState" - } - ] - } - } + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table, record history, tabular attribute, row or column not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:get-modifiable-version": { - "post": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-file": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Gets the latest modifiable record version, or creates a new one if none exists. The record version must be the latest version, and must be either released or withdrawn.", - "operationId": "GetModifiableRecordVersion", + "summary": "Create or edit a cell file datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellFileDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "row-guid", "in": "path", "required": true, "schema": { @@ -30901,7 +11337,7 @@ } }, { - "name": "record-version-guid", + "name": "column-guid", "in": "path", "required": true, "schema": { @@ -30910,145 +11346,93 @@ } } ], - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "File": { + "type": "string", + "description": "File to import.", + "format": "binary" }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + "Description": { + "type": "string", + "description": "File description." }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": true, - "canRelease": true, - "canGetModifiableVersion": false, - "canWithdraw": false, - "canDelete": true + "Target": { + "type": "string", + "description": "Sets the hyperlink target for the datum. Possible values are: 'NewWindow', 'Top', 'Parent', 'Tree', 'Content', 'CurrentFrame'. Defaults to 'NewWindow'." }, - "versionNumber": 2, - "versionState": "unreleased", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" + "AllowIndex": { + "type": "boolean", + "description": "Sets whether the datum will be available in the search index. Defaults to 'False'." + } + } + }, + "encoding": { + "File": { + "style": "form" + }, + "Description": { + "style": "form" + }, + "Target": { + "style": "form" + }, + "AllowIndex": { + "style": "form" } } } - }, - "400": { - "description": "Bad request. Record version state is not the latest version, is not released or withdrawn, or table is not version controlled.", + } + }, + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaGetModifiableRecordVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "A new version can only be created from the latest released or withdrawn record version.", - "value": { - "message": "Cannot create a new version from the record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "getModifiableRecordVersionControl", - "errors": [ - { - "message": "Invalid version state 'Superseded'.", - "reason": "invalidVersionState", - "versionState": "superseded" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot create a new version from the record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "getModifiableRecordVersionControl", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } - }, - "Example 3": { - "summary": "Record version is not the latest version.", - "value": { - "message": "Cannot create a new version from the record version with GUID 'cb18fff2-d943-44b2-81d6-79ebd7c570ca'.", - "code": "getModifiableRecordVersionControl", - "errors": [ - { - "message": "There is a newer version.", - "reason": "notTheLatestVersion", - "newerVersion": { - "versionNumber": 2, - "versionState": "unreleased", - "name": "Arsenic trioxide [1327-53-3] - new version", - "guid": "fa961614-b113-4ec3-8ff4-d1051efeb8bd" - } - } - ] - } - } + "$ref": "#/components/schemas/GsaFileDatum" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, record history, tabular attribute, row or column not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:withdraw": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Withdraws the record version. Must be a released record version.", - "operationId": "WithdrawRecordVersion", + "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database and table.", + "operationId": "SetCellPictureDatumForTabularAttributeFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -31062,7 +11446,25 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "row-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "column-guid", "in": "path", "required": true, "schema": { @@ -31071,128 +11473,89 @@ } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordVersion" - }, - "example": { - "recordHistory": { - "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" - }, - "table": { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "databaseKey": "MI_TRAINING", - "createdByUser": "A User", - "createdDate": "2018-01-01T00:00:00+00:00", - "lastModifiedByUser": "A User", - "lastModifiedDate": "2018-01-02T00:00:00+00:00", - "recordType": "record", - "shortName": "Arsenic trioxide [1327-53-3]", - "recordColor": "red", - "userCapabilities": { - "canWrite": true, - "canModify": false, - "canRelease": false, - "canGetModifiableVersion": true, - "canWithdraw": false, - "canDelete": false - }, - "versionNumber": 1, - "versionState": "withdrawn", - "name": "Arsenic trioxide [1327-53-3]", - "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" + "$ref": "#/components/schemas/GsaPictureDatum" } } } }, "400": { - "description": "Bad request. Record version state is not released, or table is not version controlled.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaWithdrawRecordVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "Only released record versions can be withdrawn.", - "value": { - "message": "Cannot withdraw record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", - "code": "withdrawRecordVersionControl", - "errors": [ - { - "message": "Invalid version state 'Unreleased'.", - "reason": "invalidVersionState", - "versionState": "unreleased" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot withdraw record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", - "code": "withdrawRecordVersionControl", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] - } - } - } - } - } + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, table, record history, tabular attribute, row or column not found" + }, + "415": { + "description": "Invalid image file" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/permission-category-access-controls": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/rows/{row-guid}/columns/{column-guid}:import-picture": { + "put": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Get permission-based access control settings for a given record version.\r\nReturns the access control for each permission in each category.", - "operationId": "GetRecordVersionPermissionCategoryAccessControls", + "summary": "Create or edit a cell picture datum for a given record history, tabular attribute, row and column in a given database.", + "operationId": "SetCellPictureDatumForTabularAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-history-guid", + "name": "row-guid", "in": "path", "required": true, "schema": { @@ -31201,7 +11564,7 @@ } }, { - "name": "record-version-guid", + "name": "column-guid", "in": "path", "required": true, "schema": { @@ -31210,107 +11573,75 @@ } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "Picture": { + "type": "string", + "description": "Picture to import.", + "format": "binary" + } + } + }, + "encoding": { + "Picture": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "$ref": "#/components/schemas/GsaPictureDatum" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table, record history or record version not found" + "description": "Database, record history, tabular attribute, row or column not found" }, - "422": { - "description": "MI not in permission-based access control mode" + "415": { + "description": "Invalid image file" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { + "post": { "tags": [ - "Records - Record Versions" + "Data" ], - "summary": "Update permission-based access control settings for a given record version.\r\nSets the access control for the given permissions.", - "operationId": "UpdateRecordVersionPermissionCategoryAccessControls", + "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database and table.", + "operationId": "SetDatumNotApplicableFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -31324,7 +11655,7 @@ } }, { - "name": "record-version-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -31333,555 +11664,108 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 1": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - } - } - }, "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } + "description": "Ok" }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '6332c49f-5490-445f-b71b-fa898414104c', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '6332c49f-5490-445f-b71b-fa898414104c' does not exist.", - "categoryGuid": "6332c49f-5490-445f-b71b-fa898414104c", - "reason": "noSuchCategory" - } - ] - } - }, - "Example 2": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '60ae7b15-9299-41e1-8c60-a4c13b84e790' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '60ae7b15-9299-41e1-8c60-a4c13b84e790' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "permissionGuid": "60ae7b15-9299-41e1-8c60-a4c13b84e790", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "reason": "noSuchPermission" - } - ] - } - }, - "Example 3": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ], - "reason": "duplicateCategoryGuids" - } - ] - } - }, - "Example 4": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ], - "reason": "duplicatePermissionGuids" - } - ] - } - } - } - } + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history or attribute not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}:set-not-applicable": { + "post": { + "tags": [ + "Data" + ], + "summary": "Sets a datum as 'not applicable' for a given attribute and record history in a given database.", + "operationId": "SetDatumNotApplicable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, record history or record version not found" + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } }, - "422": { - "description": "MI not in permission-based access control mode" + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } - } - } - }, - "/v1alpha/schema/mi-version": { - "get": { - "tags": [ - "Schema" ], - "summary": "Returns the currently running MI version to the caller.", - "operationId": "GetVersion", "responses": { "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMiVersion" - } - } - } + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history or attribute not found" } } } }, - "/v1alpha/schema:resolve-link-targets": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { "post": { "tags": [ - "Schema" + "Data" ], - "summary": "Gets all target tables that match the provided link target, for each target.\r\nThere could be several matches or no matches for each link target.\r\nFor example if two databases are loaded with the same databaseGuid and the databaseVersionGuid isn't specified,\r\nor if the databaseGuid and databaseVersionGuid are not specified and the tableGuid matches in several databases.\r\nThere could be no matches if the target database is not loaded.", - "operationId": "ResolveLinkTargets", + "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database and table.", + "operationId": "AppendValuesForDiscreteAttributeFromTable", "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } ], @@ -31889,37 +11773,33 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, "examples": { "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" } ] } }, "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } @@ -31928,37 +11808,33 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, "examples": { "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" } ] } }, "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } @@ -31967,37 +11843,33 @@ }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, "examples": { "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" } ] } }, "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } @@ -32006,37 +11878,33 @@ }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsRequest" + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, "examples": { "Example 1": { - "summary": "All GUIDs specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when all GUIDs are specified.", + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" } ] } }, "Example 2": { - "summary": "Optional GUIDs not specified", - "description": "This example demonstrates how to resolve a link target that targets the MaterialUniverse table, when some GUIDs are not specified.If the DatabaseVersionGuid is not specified, the link target could resolve to more than one table if there are other database loaded that match the criteria.", + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "linkTargets": [ + "discreteValues": [ { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" }, { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } ] } @@ -32051,257 +11919,54 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaResolveLinkTargetsInfo" - }, - "examples": { - "Example 1": { - "summary": "Resolved links", - "description": "This example shows results from resolving two link targets.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - }, - "Example 2": { - "summary": "Resolved links with multiple targets", - "description": "In this example, the first link target resolves to two copies of MaterialUniverse, each in different databases. This could happen if both databases have the same databaseGuid and the databaseVersionGuid was not specified in the request;or if the databaseGuid and databaseVersionGuid were not specified and the tableGuid matches.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" - }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - { - "databaseKey": "AnotherDatabase", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "name": "MaterialUniverse in another database", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - }, - "Example 3": { - "summary": "Resolved links with missing targets", - "description": "In this example, the first link target does not resolve to any table. This could happen if the target database is not loaded.", - "value": { - "resolvedLinkTargets": [ - { - "linkTarget": { - "databaseGuid": "58cc452d-aa0f-45d6-8bd8-90a8c853f1de", - "tableGuid": "9081b3af-cee1-4847-9820-48fb0a5eb820" - }, - "tables": [] - }, - { - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "tables": [ - { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "displayNames": { - "en": "ProcessUniverse English Display Name", - "fr": "ProcessUniverse French Display Name" - }, - "name": "ProcessUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - ] - } - ] - } - } + "$ref": "#/components/schemas/GsaDiscreteDatum" } } } }, "400": { "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history, discrete attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": { - "get": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/discrete:append-values": { + "post": { "tags": [ - "Schema - Attributes" + "Data" ], - "summary": "Get all attributes in table", - "operationId": "GetAttributes", + "summary": "Append values to the multi-valued discrete datum for a given discrete attribute and record history in a given database.", + "operationId": "AppendValuesForDiscreteAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" - } - } - } }, - "404": { - "description": "Database, table or attribute not found" - } - } - }, - "post": { - "tags": [ - "Schema - Attributes" - ], - "summary": "Create a new attribute.", - "operationId": "CreateAttribute", - "parameters": [ { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } @@ -32310,3931 +11975,5151 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaAppendDiscreteValues" }, "examples": { - "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" - } - }, - "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" - } - }, "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "79e6b2af-6e5d-4f33-9f4e-853a039d43b5" + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] } }, "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ + "discreteValues": [ { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" }, { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } - ], - "name": "Delivery date (with meta-attributes)" - } - }, - "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" - } - }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" - } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" - } - }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" - } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" - } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" - } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" - } - }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" + ] } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "discreteValues": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" + ] } }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" - } - }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] } }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" + "discreteValues": [ + { + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" + } + ] } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendDiscreteValues" + }, + "examples": { + "Example 3": { + "summary": "Append single discrete value", + "description": "This example demonstrates how to append a single value to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "discreteValues": [ + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + } + ] } }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Append multiple discrete values", + "description": "This example demonstrates how to append multiple values to the discrete datum for multi valued attribute 'Additive' (GUID = 'ec51581f-4a78-4b1b-81df-83382c541b7b') and record 'Shore A35' (Record History GUID = '8348e2a2-7b97-44e7-94a1-cb8358a06407') from table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "discreteValues": [ { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } + "guid": "6f797d8d-3e0f-4799-b82d-e395d6b6f4b4" + }, + { + "guid": "fa78c22a-cefd-42d3-9787-173c68b8485f" + }, + { + "guid": "76b327e7-f7f7-4e2d-b617-cc1822687af0" } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + ] } - }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteDatum" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history, discrete attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "post": { + "tags": [ + "Data" + ], + "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database and table.", + "operationId": "AppendValuesForPointAttributeFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 1": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "values": [ { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + ] } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "values": [ { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] }, { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "expressions": [ + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 1": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 + ] + } + }, + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 + ] + }, + { + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameterRange": { - "parameterValues": [ - { + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } - ] + } + } + ] + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 1": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } } - } - ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + ] + } + ] } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 2": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ + "values": [ { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] }, { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + ] } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "$ref": "#/components/schemas/GsaAppendPointValues" }, "examples": { "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] + } + ] } }, "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" - } - }, - "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "79e6b2af-6e5d-4f33-9f4e-853a039d43b5" - } - }, - "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ + "values": [ { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" - } - }, - "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" - } - }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" - } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" - } - }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" - } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" - } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" - } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" - } - }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" - } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] + }, { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" - } - }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", - "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" - } - }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", - "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" - } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" + ] } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPointDatum" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history, point attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/attributes/{attribute-guid}/point:append-values": { + "post": { + "tags": [ + "Data" + ], + "summary": "Append values to the multi-valued point datum for a given point attribute and record history in a given database.", + "operationId": "AppendValuesForPointAttribute", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] + } + ] } }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "values": [ { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] + }, + { + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + ] } - }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "values": [ { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + ] } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "values": [ { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] }, { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "expressions": [ + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] } - ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 + ] + } + }, + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 + ] + }, + { + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + ] + }, + { + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameterRange": { - "parameterValues": [ - { + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" } - ] + } + } + ] + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppendPointValues" + }, + "examples": { + "Example 3": { + "summary": "Append single point value with parameters", + "description": "This example demonstrates how to append a single value to the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", + "value": { + "values": [ + { + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } } - } - ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + ] + } + ] } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 4": { + "summary": "Append multiple point values with parameters", + "description": "This example demonstrates how to append multiple values to the the point datum for multi valued attribute 'Yield Strength' (GUID = '2b233cf4-fd42-4ab0-b8de-2227c9b71248') and record 'Ti' (Record History GUID = '9eda63e8-c035-451f-9ccb-c9ff47f9a755') from table 'Training Exercise for Import' (GUID = '0404f83b-64fb-47b1-8f3c-3388c513c9b0') from database 'MI Training'.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ + "values": [ { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" + "pointValue": 1190.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + } + } + ] }, { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "pointValue": 1240.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + } + } + ] }, { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" + "pointValue": 1290.0, + "parametersAndValues": [ + { + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 293.0 + } + }, + { + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterValue": { + "parameterType": "discrete", + "parameterValue": { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + } + } + } + ] } - ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + ] } } } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPointDatum" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, record history, point attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}:search-index-status": { + "get": { + "tags": [ + "Database" + ], + "summary": "Get Search Index Status for a given database", + "operationId": "GetSearchIndexStatus", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "include-errors", + "in": "query", + "description": "", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSearchIndexStatus" + } + } + } + }, + "403": { + "description": "Forbidden is returned if include diagnostics is requested and the current user is not an administrator" + }, + "404": { + "description": "Database key not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given table. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromTableName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-identity}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayout", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "layout-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-identity}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutWithTableName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "layout-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-identity}/layout/{layout-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "layout-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-name}/layout/{layout-name}:generate-integration-schema": { + "get": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema from the attributes in the given layout. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromLayoutNameWithTableName", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "layout-name", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/standard-names:generate-integration-schema": { + "post": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema with attributes for each provided standard name in the given database. The user must be an Admin user for the database.", + "operationId": "GenerateSchemaFromStandardNames", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json-patch+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/standard-names:generate-integration-schema": { + "post": { + "tags": [ + "Database" + ], + "summary": "Generate an integration schema with attributes for each provided standard name. This will include attribute from all loaded databases for which the user is an Admin.", + "operationId": "GenerateSchemaFromStandardNamesAllDatabases", + "requestBody": { + "description": "", + "content": { + "application/json-patch+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGeneratedIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}:export": { + "post": { + "tags": [ + "DataExport" + ], + "summary": "Export data from the given database.", + "operationId": "ExportData", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" - } - }, - "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" - } - }, - "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "79e6b2af-6e5d-4f33-9f4e-853a039d43b5" - } - }, - "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" - } - }, - "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" - }, - { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" - } - ], - "name": "Delivery date (with meta-attributes)" - } - }, - "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" - } - }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" - } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" - } - }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" - } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" - } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" - } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" - } - }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" - } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" - } - }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", - "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" - } - }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", - "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" - } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" - } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", - "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" - } - }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - } - ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" - } - }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - } - ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" - } - }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" }, { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" } ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } + "recordProperties": [ + "fullName", + "recordColor" ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" - }, + "attributes": [ { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" }, { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" } ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Date-time attribute", - "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date" - } - }, - "Example 2": { - "summary": "Date-time attribute with display names", - "description": "This example demonstrates how to create a new date-time attribute with French and German display names for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", - "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "displayNames": { - "fr": "La date de livraison", - "de": "Liefertermin" - }, - "name": "Delivery date (display names)" + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, "Example 3": { - "summary": "Date-time attribute with guid", - "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "name": "Delivery date (guid)", - "guid": "79e6b2af-6e5d-4f33-9f4e-853a039d43b5" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 4": { - "summary": "Date-time attribute with IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "type": "dateTime", - "defaultThresholdType": "exists", - "isHiddenFromSearchCriteria": true, - "name": "Delivery date (hidden from search criteria)" + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 5": { - "summary": "Date-time attribute with meta-attributes", - "description": "This example demonstrates how to create a new date-time attribute with meta-attributes for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "type": "dateTime", - "defaultThresholdType": "atMost", - "metaAttributes": [ - { - "type": "logical", - "defaultThresholdType": "exists", - "name": "Logical meta-attribute" - }, + "attributes": [ { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Text meta-attribute" + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } ], - "name": "Delivery date (with meta-attributes)" + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, "Example 6": { - "summary": "Discrete attribute - simple", - "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": false, - "defaultThresholdType": "isOneOf", - "name": "Used material type" - } - }, - "Example 7": { - "summary": "Discrete attribute - multi-valued", - "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "discreteType": { - "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" - }, - "isMultiValued": true, - "defaultThresholdType": "isOneOf", - "name": "Appropriate material types" - } - }, - "Example 8": { - "summary": "File attribute", - "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "file", - "defaultThresholdType": "exists", - "name": "Details PDF" - } - }, - "Example 9": { - "summary": "Hyperlink attribute", - "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "hyperlink", - "defaultThresholdType": "exists", - "name": "Supplier website" - } - }, - "Example 10": { - "summary": "Integer attribute", - "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": false, - "defaultThresholdType": "atLeast", - "name": "Number of batches" - } - }, - "Example 11": { - "summary": "Integer attribute - unique", - "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "integer", - "isUnique": true, - "defaultThresholdType": "atLeast", - "name": "Batch ID Number" - } - }, - "Example 12": { - "summary": "Logical attribute", - "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "logical", - "defaultThresholdType": "equal", - "name": "Inspected" - } - }, - "Example 13": { - "summary": "Long text attribute", - "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "longText", - "defaultThresholdType": "exists", - "name": "Long Description" - } - }, - "Example 14": { - "summary": "Picture attribute", - "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "picture", - "defaultThresholdType": "exists", - "name": "Photo" - } - }, - "Example 15": { - "summary": "Point attribute - simple unitless", - "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "name": "My Shape factor" - } - }, - "Example 16": { - "summary": "Point attribute - simple with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", - "value": { - "type": "point", - "isMultiValued": false, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Mass" - } - }, - "Example 17": { - "summary": "Point attribute - multi-valued with unit", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Observed masses" - } - }, - "Example 18": { - "summary": "Point attribute - multi-valued with parameters", - "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "attributes": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } ], - "defaultThresholdType": "atLeast", - "name": "Max ratio" - } - }, - "Example 19": { - "summary": "Range attribute - unitless", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", - "value": { - "type": "range", - "defaultThresholdType": "atLeast", - "name": "Average permeability" - } - }, - "Example 20": { - "summary": "Range attribute - with unit", - "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", - "value": { - "type": "range", - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "name": "Boiling point" - } - }, - "Example 21": { - "summary": "Short text attribute", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Label" - } - }, - "Example 22": { - "summary": "Short text attribute - unique", - "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", - "value": { - "type": "shortText", - "isUnique": true, - "defaultThresholdType": "exists", - "name": "Serial number" + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 23": { - "summary": "Float functional attribute", - "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 7": { + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "floatFunctional", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "attributes": [ { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameter": { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" } ], - "isRange": true, - "defaultThresholdType": "atLeast", - "name": "Electrical resistance with temperature" + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, - "Example 24": { - "summary": "Discrete functional attribute", - "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 8": { + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "type": "discreteFunctional", - "discreteType": { - "guid": "0000000c-0006-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ + "attributes": [ { - "type": "discrete", - "parameter": { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } ], - "defaultThresholdType": "equal", - "name": "Environmental resistance" + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } }, - "Example 25": { - "summary": "Maths functional attribute", - "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", "value": { - "type": "mathsFunctional", - "unit": { - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" }, { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } ], - "expressions": [ - { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } + "recordProperties": [ + "tableName", + "fullName" ], - "allowExtrapolation": false, - "isRange": false, - "defaultContent": { - "curveLabel": "Curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "expression": { - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - }, - "freeParameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 25000000.0, - "parameterRange": { - "lowValue": 20000000.0, - "highValue": 30000000.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "value": -0.25, - "parameterRange": { - "lowValue": -0.5, - "highValue": 0.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterValue": { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - } - ] - }, - "allowAllCompatibleExpressions": false, - "allowAnonymousExpressions": false, - "defaultThresholdType": "equal", - "name": "Fatigue strength model" + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, - "Example 26": { - "summary": "Tabular attribute", - "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "Example 10": { + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", "value": { - "type": "link", - "displayFullTable": false, - "displaySummaryRowInline": true, - "hideUnlinkedRows": true, - "tabularColumns": [ - { - "columnType": "localLogical", - "defaultThresholdType": "contains", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Comments" - }, + "attributes": [ { - "columnType": "linkedAttribute", - "linkedAttribute": { - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "name": "Substance" + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" }, { - "columnType": "linkedColumn", - "linkedColumn": { - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "showAsLink": true, - "summaryRowEnabled": true, - "rollUpType": "min", - "summaryRowRollUpType": "list", - "name": "Rating" + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" } ], - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "defaultThresholdType": "exists", - "name": "Restricted Substances" + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttribute" }, - "examples": { - "Example 5": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 6": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ + "Example 11": { + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + "value": { + "attributes": [ + { + "localData": [ { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" } ], - "standardNames": [ + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" } ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 12": { + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", + "value": { + "attributes": [ + { + "localData": [ { - "name": "Source of data (MaterialUniverse)", - "guid": "c79657a3-7148-4592-bf53-13e47d4341fb" + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" } ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 8": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 13": { + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" } ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeCreationException" }, - "examples": { - "Example 1": { - "summary": "No such discrete type", - "description": "The GUID provided for the discrete type does not match a discrete type in the database.", - "value": { - "message": "Cannot create attribute 'Used material type'.", - "code": "attributeCreation", - "errors": [ - { - "message": "Could not find discrete type with GUID 'd26de1ac-58a2-4584-993d-27913d71e73f' in database 'MI_Training'.", - "guid": "d26de1ac-58a2-4584-993d-27913d71e73f", - "databaseKey": "MI_Training", - "entityType": "discreteType", - "reason": "noSuchEntity" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for creating a MathsFunctional Attribute", - "description": "Unit not found; no expressions specified (and 'allow anonymous expressions' not set to true); parameterContents contains a parameter that is not in attributeParameters", - "value": { - "message": "Cannot create attribute 'Fatigue strength model'.", - "code": "attributeCreation", - "errors": [ - { - "message": "Could not find unit with GUID '9674c685-cd35-43d3-9b7b-b7884dc423d1' in database 'MI_Training'.", - "guid": "9674c685-cd35-43d3-9b7b-b7884dc423d1", - "databaseKey": "MI_Training", - "entityType": "unit", - "reason": "noSuchEntity" + "Example 14": { + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] }, - { - "message": "The Maths Functional attribute is not valid.", - "errors": [ - { - "message": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.", - "reason": "noExpressions" + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" + }, + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] }, - { - "message": "Parameters in parameter contents must be from this attribute's parameters. GUIDs not found in attribute's parameters: '18b75b07-4a36-4db2-9130-6a5d576fffd5'.", - "parameterGuids": [ - "18b75b07-4a36-4db2-9130-6a5d576fffd5" - ], - "reason": "parameterContentUnknownParameters" - } - ], - "reason": "mathsFunctional" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateDateTimeAttribute: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] } } } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": { - "get": { - "tags": [ - "Schema - Attributes" - ], - "summary": "Get attribute in table", - "operationId": "GetAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 1": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 2": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] + } + }, + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 3": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] + } + }, + "Example 3": { + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 4": { + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", + "value": { + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 5": { + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] + } + }, + "Example 6": { + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 7": { + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] + } + }, + "Example 8": { + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] + } + }, + "Example 9": { + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" } ], - "standardNames": [ + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 10": { + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", + "value": { + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" } ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] + } + }, + "Example 11": { + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", + "value": { + "attributes": [ + { + "localData": [ { - "name": "Source of data (MaterialUniverse)", - "guid": "2aa7ea6e-cc3e-40ce-850b-35759c1ff237" + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" } ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 4": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 12": { + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 13": { + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", + "value": { + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] + } + }, + "Example 14": { + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" } ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } - } - } - } - }, - "404": { - "description": "Database, table or attribute not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Attributes" - ], - "summary": "Update attribute.", - "operationId": "UpdateAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { + }, + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", + "value": { + "attributes": [ + { + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" + }, + { + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + } + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] + } + } + } + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "type": "discrete", - "name": "Metals (updated)" + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "displayNames": { - "fr": null - } + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "type": "discrete", - "displayNames": null + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "discrete", - "defaultThresholdType": "equal" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } }, "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", "value": { - "type": "discrete", - "isMultiValued": true + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", "value": { - "type": "shortText", - "isUnique": true + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", "value": { - "type": "point", - "isMultiValued": true + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "attributes": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" ] } }, "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" - } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", - "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - } - }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" ] } }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" }, { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" } - } - ] - } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } - } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] } } } }, - "application/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaDataExportRequest" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record history GUIDs.", "value": { - "type": "discrete", - "name": "Metals (updated)" + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordHistoryGuids": [ + "ba22491d-b470-42cf-80d7-531ff81b1583", + "d0237d48-ddd2-4916-b24c-86ba51f25b52" + ] } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for attributes 'Shape factor' and 'Young's modulus' from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } + "attributes": [ + { + "attributeType": "simple", + "guid": "00000144-0001-4fff-8fff-dd92ffff0000" + }, + { + "attributeType": "simple", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + } + ], + "recordProperties": [ + "fullName", + "recordColor" + ], + "recordVersionGuids": [ + "00000026-000e-4fff-8fff-dd92ffff0000", + "0000098c-000e-4fff-8fff-dd92ffff0000" + ] } }, "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "displayNames": { - "fr": null - } + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - no target specified", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. This export does not specify the target of the link group (database, table), so the one defined in the schema will be used as default instead.", "value": { - "type": "discrete", - "displayNames": null + "attributes": [ + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - In Reversed Direction", + "description": "This example demonstrates how to export linked records from the record 'MTS-615721' in the 'Tensile Test Data' table from the 'MI_Training' database, following the record link group 'Metals Pedigree', which is the reverse of link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" + "attributes": [ + { + "localData": [], + "targetTableGuid": "ad27baf0-42e9-4136-bc96-9dbbf116e265", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": true, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "a7d055c8-300c-4b0f-9d22-a4ea2c4a8251" + ] } }, "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - include indirect links", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data' including indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "include", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - exclude indirect links", + "description": "This example demonstrates how to export linked records from the record '300°F' in the 'Tensile Statistical Data' table from the 'MI_Training' database, following the record link group 'Design Data' excluding indirectly linked records. By default the behavior of indirect links is inherited from the link definition.", "value": { - "type": "discrete", - "defaultThresholdType": "equal" + "attributes": [ + { + "localData": [], + "targetTableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "exclude", + "guid": "0aa93d4c-1393-4cf5-b172-3855349ef42c" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "f3182449-8042-4bd2-89e5-88505cbbc85f" + ] } }, "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Linked Records Export - Dynamic Link", + "description": "This example demonstrates how to export linked records from the record 'LBU14' in the 'Composite Pedigree' table from the 'MI_Training' database, following the dynamic record link group 'Tensile Test Data'.", "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true + "attributes": [ + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "dynamicLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "c8b93abd-f834-464e-b02e-a3cb52a04507" + ] } }, "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Linked Data Export", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' and 'Test Temperature'.", "value": { - "type": "discrete", - "isMultiValued": true + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "summary": "Linked Data Export - Rollup", + "description": "This example demonstrates how to export linked records from the record 'Batch 921' in the 'Metals Pedigree' table from the 'MI_Training' database, following the record link group 'Tensile Test Data'. It includes the linked records' full name and color, and data for attributes 'Young's Modulus (11-axis)' with 'Mean' rollup and 'Test Temperature' with 'Max' rollup.", "value": { - "type": "shortText", - "isUnique": true + "attributes": [ + { + "attributeType": "simple", + "guid": "a93a36c1-78d6-4254-b245-c7445d1038da" + }, + { + "localData": [], + "targetTableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "attributeType": "link", + "linkAttributeType": "recordLink", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName", + "recordColor" + ], + "attributes": [ + { + "rollUpType": "mean", + "attributeType": "simple", + "guid": "086c31a6-b047-4ee1-bdb7-ce66ea9e9b46" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "b3503337-8287-4946-b312-2100fb51779d" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f" + } + ], + "recordProperties": [ + "tableName", + "fullName" + ], + "recordHistoryGuids": [ + "d2f51a3d-c274-4a1e-b7c9-8ba2976202cc" + ] } }, "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Tabular Data Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute", "value": { - "type": "point", - "isMultiValued": true + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Tabular Data Export - no target specified", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It includes the local column 'Amount', the linked attribute 'Chemical name' (in the 'Restricted substances' table), and the linked column 'Effective date' from the 'Legislations restricting its use' tabular attribute. This export does not specify the tabular targets (database, table and attribute), so the ones defined in the schema will be used as defaults instead.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "attributes": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "localData": [], + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "b48b1749-63e3-4233-8c4d-8d5857442955" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" ] } }, "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "summary": "Tabular Data Filtered Export", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. Only rows where there is a linked record in the 'All Substances' subset will be returned ", "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } + "attributes": [ + { + "localData": [ + { + "attributeType": "simple", + "guid": "089b6f3e-02bb-4f66-ab9e-0e6961f4d69e" + } + ], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + } + ], + "linkedRecordsExportBehavior": { + "tabularRowBehavior": "onlyRowsWithVisibleLinkedRecords", + "rollUpTypes": [], + "linkedRecordsCriterion": { + "subsetGuid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9", + "type": "subset" + } + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" + ] } }, "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" - } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", - "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - } - }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "summary": "Tabular Data With Summary Row and Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'Barium silicate' in the 'MaterialUniverse' table from the 'MI_Training' database. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the maximum of the 'SVHC under REACH' attribute, and a summary row of the linked records and their chemical names", "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "summaryRollUpType": "listDistinct", + "attributeType": "simple", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + { + "rollUpType": "max", + "attributeType": "simple", + "guid": "ed238f84-fe8f-4cdc-a07d-82d358462b32" + } + ], + "linkedRecordsExportBehavior": { + "summaryRollUpType": "listDistinct", + "rollUpTypes": [] }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } + ], + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "17877254-3a26-4a28-94d6-9f6be164914c" ] } }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "Example 15": { + "summary": "Tabular Data With Linked Columns Tabular Rollup", + "description": "This example demonstrates how to export tabular data from the record 'PVC-elastomer (Shore A35)' in the 'MaterialUniverse' table from database 'MI Training'. It exports data from the tabular attribute 'Restricted substances associated with this material'. It will include a tabular rollup of the linked Legislation records, and the minimum of the 'Rating' attribute in the 'Legislations and Lists' table.", "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, + "attributes": [ { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ + "localData": [], + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "attributes": [ + { + "localData": [], + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab", + "attributeType": "link", + "linkAttributeType": "tabularAttribute", + "exportInReversedDirection": false, + "recordProperties": [ + "fullName" + ], + "attributes": [ { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + "attributeType": "simple", + "guid": "fbbe284e-ad31-4b01-a371-34bc0ff1d2d0" }, { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + "rollUpType": "min", + "attributeType": "simple", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + ], + "linkedRecordsExportBehavior": { + "rollUpTypes": [ + "list" + ] + }, + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" } - } - ] - } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + ], + "indirectLinksBehavior": "fromLinkDefinition", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" - } - } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null + "recordProperties": [ + "fullName" + ], + "recordHistoryGuids": [ + "8348e2a2-7b97-44e7-94a1-cb8358a06407" + ] } } } - }, - "text/json": { + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + } + } + }, + "404": { + "description": "Database not found" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/v1alpha/integration-schemas/{schema}:export": { + "post": { + "tags": [ + "DataExport" + ], + "summary": "Export data from the integration schema.", + "operationId": "ExportDataFromIntegrationSchema", + "parameters": [ + { + "name": "schema", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", "value": { - "type": "discrete", - "name": "Metals (updated)" + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] } }, "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } - } - }, - "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": null - } - } - }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": null - } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" - } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "defaultThresholdType": "equal" - } - }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true - } - }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "isMultiValued": true - } - }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true - } - }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "point", - "isMultiValued": true + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ + "recordReferences": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" } + ], + "attributeIdentities": [ + 1 ] } }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", - "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } - } - }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" + "recordReferences": [ + { + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + }, + { + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" + }, + { + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] } }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "floatFunctional", - "attributeParameters": [ + "recordReferences": [ { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" }, { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" + } + ], + "attributeIdentities": [ + 1 + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationDataExportRequest" + }, + "examples": { + "Example 1": { + "summary": "Data Export by Record History", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database.", + "value": { + "recordReferences": [ + { + "recordReferenceType": "history", + "recordHistoryGuid": "ba22491d-b470-42cf-80d7-531ff81b1583", + "databaseKey": "MI_TRAINING" }, { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "recordReferenceType": "history", + "recordHistoryGuid": "d0237d48-ddd2-4916-b24c-86ba51f25b52", + "databaseKey": "MI_TRAINING" } + ], + "attributeIdentities": [ + 1 ] } }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "Example 2": { + "summary": "Data Export by Record Version", + "description": "This example demonstrates how to export data for Integration Schema attribute with identity 1 from the records 'Alumino Silicate - 1720' and '250 Maraging Steel' in the 'MaterialUniverse' table from the 'MI_Training' database, by specifying the record version GUIDs.", "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, + "recordReferences": [ { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" + "recordVersionGuid": "00000026-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" }, { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + "recordVersionGuid": "0000098c-000e-4fff-8fff-dd92ffff0000", + "recordReferenceType": "version", + "databaseKey": "MI_TRAINING" } ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - }, - "parameterContents": [ + "attributeIdentities": [ + 1 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataExportResponse" + } + } + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { + "get": { + "tags": [ + "Graph" + ], + "summary": "Get the graph for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForVersionFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 1": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" }, + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + "constraintParameters": [ { "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 + } + } + } + } + } + }, + "400": { + "description": "Attribute is not a float or discrete functional attribute" + }, + "404": { + "description": "Database, table, record history, record version, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { + "get": { + "tags": [ + "Graph" + ], + "summary": "Get the graph for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForLatestFromTable", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraph" + }, + "examples": { + "Example 2": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" }, { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" } - ] - } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 } } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null - } } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "name": "Metals (updated)" - } - }, - "Example 2": { - "summary": "Update display names", - "description": "This example demonstrates how to update the French and German display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": "Métaux", - "de": "Metalle" - } - } - }, - "Example 3": { - "summary": "Remove fr display name", - "description": "This example demonstrates how to remove the French display name of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": { - "fr": null - } - } - }, - "Example 4": { - "summary": "Remove all display names", - "description": "This example demonstrates how to remove all display names of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "displayNames": null - } - }, - "Example 5": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "guid": "12345678-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 6": { - "summary": "Update help path", - "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "helpPath": "html/attributenotes/metals.html" - } - }, - "Example 7": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "defaultThresholdType": "equal" - } - }, - "Example 8": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", - "value": { - "type": "discrete", - "isHiddenFromSearchCriteria": true - } - }, - "Example 9": { - "summary": "Make discrete multi-valued", - "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "discrete", - "isMultiValued": true - } - }, - "Example 10": { - "summary": "Make short text unique", - "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true - } - }, - "Example 11": { - "summary": "Make point multi-valued", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true - } - }, - "Example 12": { - "summary": "Make point multi-valued with parameter", - "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a smart link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", - "value": { - "type": "point", - "isMultiValued": true, - "attributeParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ] - } - }, - "Example 13": { - "summary": "Update unit", - "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", - "value": { - "type": "range", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - } - } - }, - "Example 14": { - "summary": "Update multiple properties", - "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", - "value": { - "type": "shortText", - "isUnique": true, - "name": "Grain size (updated)" - } - }, - "Example 15": { - "summary": "Turn an attribute into a meta-attribute", - "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", - "value": { - "type": "shortText", - "aboutAttribute": { - "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - } + } + }, + "400": { + "description": "Attribute is not a float or discrete functional attribute" + }, + "404": { + "description": "Database, table, record history, attribute or datum not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph": { + "get": { + "tags": [ + "Graph" + ], + "summary": "Get a graph for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraph" }, - "Example 16": { - "summary": "Add multiple parameters", - "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", - "value": { - "type": "floatFunctional", - "attributeParameters": [ - { - "type": "numeric", - "defaultValue": 5.0, - "interpolationMethod": "auto", - "scaleType": "notSet", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "interpolationMethod": "linear", - "scaleType": "logarithmic", - "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "defaultValue": { - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + "examples": { + "Example 3": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", + "value": { + "functionalType": "float", + "series": [ + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" }, - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - } - }, - "Example 17": { - "summary": "Add additional parameter and set default content for Maths Functional Attribute", - "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", - "value": { - "type": "mathsFunctional", - "attributeParameters": [ - { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ], - "defaultContent": { - "curveLabel": "Updated curve label", - "transposeAxes": true, - "useLogarithmicScale": true, - "freeParameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + { + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false + }, + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" + } + ], + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" }, - "parameterContents": [ - { - "type": "numeric", - "value": 15.0, - "parameterRange": { - "lowValue": 5.0, - "highValue": 100.0 - }, - "parameter": { - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - } - }, + "constraintParameters": [ { "type": "numeric", - "parameterRange": { - "lowValue": -2.0 - }, - "parameter": { - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - }, - { - "type": "discrete", - "parameterRange": { - "parameterValues": [ - { - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - } - ] - }, - "parameter": { - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" } - ] - } - } - }, - "Example 18": { - "summary": "Update tabular columns", - "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "All Legislation Names", - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" - }, - { - "columnType": "linkedAttribute", - "showAsLink": true, - "summaryRowEnabled": false, - "rollUpType": "min", - "summaryRowRollUpType": "listDistinct", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - { - "columnType": "linkedAttribute", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" - }, - { - "columnType": "localPoint", - "defaultThresholdType": "exists", - "showAsLink": false, - "summaryRowEnabled": false, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" - } - ], - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - } - }, - "Example 19": { - "summary": "Update tabular target", - "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": { - "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + ], + "numberOfPoints": 8 } } - }, - "Example 20": { - "summary": "Remove tabular target", - "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", - "value": { - "type": "link", - "target": null - } } } } + }, + "400": { + "description": "Attribute is not a float or discrete functional attribute" + }, + "404": { + "description": "Database, record history, record version, attribute or datum not found" } - }, + } + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph": { + "get": { + "tags": [ + "Graph" + ], + "summary": "Get the graph for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", + "operationId": "GetGraphForLatest", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaGraph" }, "examples": { - "Example 9": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 10": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 11": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "fceca1cf-c87c-421b-9593-68a993655ae3" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 12": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "Example 4": { + "summary": "Float series graph.", + "description": "Example response for a float series graph with X-axis parameter 'Number of Cycles' and a constraint parameter of 'Temperature'. The graph contains 2 series each containing 4 points.", "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ + "functionalType": "float", + "series": [ { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 300.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 53.12, + "yHighValue": 54.5, + "estimated": false }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + { + "xValue": 5000.0, + "yLowValue": 62.58, + "yHighValue": 64.57, + "estimated": false + }, + { + "xValue": 25000.0, + "yLowValue": 73.06, + "yHighValue": 74.9, + "estimated": false + }, + { + "xValue": 12500.0, + "yLowValue": 85.34, + "yHighValue": 87.91, + "estimated": false + } + ], + "graphDecoration": "linesOnly" }, { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + "constraints": [ + { + "parameter": { + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + "parameterDataValue": { + "parameterType": "numeric", + "parameterValue": 400.0 + } + } + ], + "points": [ + { + "xValue": 1000.0, + "yLowValue": 95.86, + "yHighValue": 97.43, + "estimated": false }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + { + "xValue": 5000.0, + "yLowValue": 106.7, + "yHighValue": 108.42, + "estimated": true + }, + { + "xValue": 25000.0, + "yLowValue": 119.85, + "yHighValue": 121.04, + "estimated": true + }, + { + "xValue": 12500.0, + "yLowValue": 134.75, + "yHighValue": 137.19, + "estimated": false + } + ], + "graphDecoration": "linesOnly" } ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "graphType": "series", + "xAxisParameter": { + "type": "numeric", + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + "constraintParameters": [ + { + "type": "numeric", + "name": "Temperature", + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "numberOfPoints": 8 } } } @@ -36242,133 +17127,63 @@ } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table or attribute not found" + "description": "Database, table, record history, attribute or datum not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { + "post": { "tags": [ - "Schema - Attributes" + "Graph" ], - "summary": "Delete an attribute.", - "operationId": "DeleteAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given database, table, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphForVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "attribute-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad request. Attribute in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttributeDeletionException" - }, - "example": { - "message": "Cannot delete attribute with GUID '000000e3-0001-4fff-8fff-dd92ffff0000'.", - "code": "deletion", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000", - "errors": [ - { - "message": "It is being used in version controlled data.", - "reason": "usage", - "referencedByType": "versionControlledData" - }, - { - "message": "It is being used in one or more expressions.", - "reason": "usage", - "referencedByType": "expression", - "referencedBy": [ - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ] - } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Database, table or attribute not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": { - "get": { - "tags": [ - "Schema - Attributes" - ], - "summary": "Get all meta-attributes in table", - "operationId": "GetMetaAttributes", - "parameters": [ { - "name": "database-key", + "name": "record-version-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -36397,61 +17212,232 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 1": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 1": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 1": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 1": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" + "$ref": "#/components/schemas/GsaGraphValue" + }, + "examples": { + "Example 1": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 2": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 3": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 4": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } + } } } } }, + "400": { + "description": "Attribute is not a float or discrete functional attribute" + }, "404": { - "description": "Database or table not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { + "post": { "tags": [ - "Schema - Attributes" + "Graph" ], - "summary": "Get meta-attribute in table", - "operationId": "GetMetaAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database and table. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphValueForLatestFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "meta-attribute-guid", + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, @@ -36480,505 +17466,374 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 13": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 14": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 15": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "6867ab24-d24f-4b2c-9dd5-db207724b324" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 16": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 2": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphValue" + }, + "examples": { + "Example 5": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false + } + }, + "Example 6": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 7": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 8": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" } } } } } }, + "400": { + "description": "Attribute is not a float or discrete functional attribute" + }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Database, table, record history, attribute or datum not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/record-versions/{record-version-guid}/attributes/{attribute-guid}/graph:evaluate": { + "post": { "tags": [ - "Schema - Attributes" + "Graph" ], - "summary": "Update meta-attribute.", - "operationId": "UpdateMetaAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given database, record history, record version and attribute. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphForVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record-history-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "record-version-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "meta-attribute-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true - } - }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "type": "longText", - "aboutAttribute": null + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true - } - }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "type": "longText", - "aboutAttribute": null + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true - } - }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "type": "longText", - "aboutAttribute": null + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAttribute" + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" }, "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "name": "Notes (flammability)" - } - }, - "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "guid": "12345678-1234-4fff-8fff-0000ffff0000" - } - }, "Example 3": { - "summary": "Update default threshold type", - "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "defaultThresholdType": "equal" - } - }, - "Example 4": { - "summary": "Update IsHiddenFromSearchCriteria", - "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", - "value": { - "type": "longText", - "isHiddenFromSearchCriteria": true - } - }, - "Example 5": { - "summary": "Turn a meta-attribute into an attribute", - "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", "value": { - "type": "longText", - "aboutAttribute": null + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] } } } @@ -36987,267 +17842,55 @@ }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" + "$ref": "#/components/schemas/GsaGraphValue" }, "examples": { - "Example 17": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "Example 9": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false } }, - "Example 18": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "Example 10": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true } }, - "Example 19": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "Example 11": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "7d1462d9-261e-4816-a395-3a38bab59c08" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } } }, - "Example 20": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "Example 12": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + "graphValueType": "noValueExists" } } } @@ -37255,142 +17898,320 @@ } }, "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Database, table, record history, attribute or datum not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest/attributes/{attribute-guid}/graph:evaluate": { + "post": { "tags": [ - "Schema - Attributes" + "Graph" ], - "summary": "Delete a meta-attribute.", - "operationId": "DeleteMetaAttribute", + "summary": "Evaluate the graph for a given set of parameter values for a given attribute and the latest version of a record history in a given database. Must be a float or discrete functional attribute.", + "operationId": "EvaluateGraphValueForLatest", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "meta-attribute-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 4": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 4": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 4": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaGraphEvaluationSettings" + }, + "examples": { + "Example 4": { + "summary": "Numeric and Discrete Parameters", + "description": "This example demonstrates how to evaluate a graph with a value of 273.14K for the numeric parameter Temperature and a value of Strong Acids for the discrete parameter Chemical Environment.", + "value": { + "parametersWithValues": [ + { + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", + "parameterValue": { + "parameterType": "numeric", + "parameterValue": 273.14 + } + }, + { + "parameterGuid": "b7cee874-160f-439a-a784-b887c516b2d5", + "parameterValue": { + "parameterType": "discrete", + "parameterValueGuid": "6168c5e2-551c-49d3-90bd-ce196adf6310" + } + } + ] + } + } + } + } + } + }, "responses": { - "400": { - "description": "Bad request", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeDeletionException" + "$ref": "#/components/schemas/GsaGraphValue" }, - "example": { - "message": "Cannot delete attribute with GUID 'c364a85c-1779-4b40-94c9-888219f06579'.", - "code": "deletion", - "guid": "c364a85c-1779-4b40-94c9-888219f06579", - "errors": [ - { - "message": "It is being used in version controlled data.", - "reason": "usage", - "referencedByType": "versionControlledData" - }, - { - "message": "It is being used in one or more search masks.", - "reason": "usage", - "referencedByType": "searchMask", - "referencedBy": [ - { - "name": "Search mask that searches in Notes", - "guid": "495a7e44-3461-40c5-9ec5-def5b22d4dfb" - } - ] + "examples": { + "Example 13": { + "summary": "Range graph value - value exists.", + "description": "Example response for evaluating a float functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": false } - ] + }, + "Example 14": { + "summary": "Range graph value - interpolated value.", + "description": "Example response for evaluating a float functional graph where an interpolated value is returned at the input parameter values.", + "value": { + "graphValueType": "range", + "lowValue": 8.659, + "highValue": 8.703, + "lowValueIsInclusive": true, + "highValueIsInclusive": true, + "estimated": false, + "interpolated": true + } + }, + "Example 15": { + "summary": "Discrete graph value - value exists.", + "description": "Example response for evaluating a discrete functional graph where a value does exist at the input parameter values.", + "value": { + "graphValueType": "discrete", + "value": { + "name": "Used in Production", + "guid": "725244fb-c182-418a-91d8-c07294990c13" + } + } + }, + "Example 16": { + "summary": "No value exists.", + "description": "Example response for evaluating a functional graph where no value exist at the input parameter values.", + "value": { + "graphValueType": "noValueExists" + } + } } } } }, - "200": { - "description": "OK" - }, - "403": { - "description": "Forbidden" + "400": { + "description": "Attribute is not a float or discrete functional attribute" }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Database, table, record history, attribute or datum not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": { + "/v1alpha/help-location/url/{help-key}": { "get": { "tags": [ - "Schema - Attributes" + "HelpLocation" ], - "summary": "Get meta-attributes for attribute", - "operationId": "GetMetaAttributesForAttribute", + "summary": "Returns the URL that the given helpKey maps to.", + "operationId": "GetHelpUrl", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "help-key", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The help key.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } - }, + } + ], + "responses": { + "200": { + "description": "Ok" + } + } + } + }, + "/v1alpha/help-location/redirect/{help-key}": { + "get": { + "tags": [ + "HelpLocation" + ], + "summary": "Redirects client to the URL that the given helpKey maps to.", + "operationId": "GetHelpUrlRedirect", + "parameters": [ { - "name": "attribute-guid", + "name": "help-key", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", + "description": "The help key.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK" }, + "302": { + "description": "Redirect to the help location." + } + } + } + }, + "/v1alpha/identities": { + "post": { + "tags": [ + "Identities" + ], + "summary": "For internal use only.\r\nTranslates guids to identities.", + "operationId": "TranslateGuidsToIdentities", + "parameters": [ { "name": "mode", "in": "query", @@ -37415,574 +18236,270 @@ "type": "string" } } - ], + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesRequest" + } + } + } + }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributesInfo" + "$ref": "#/components/schemas/GsaTranslateGuidsToIdentitiesResponse" } } } }, - "404": { - "description": "Database, table or attribute not found" + "400": { + "description": "Bad request" } } - }, - "post": { + } + }, + "/v1alpha/integration-schemas": { + "get": { "tags": [ - "Schema - Attributes" + "Integration" ], - "summary": "Create a new meta-attribute for attribute.", - "operationId": "CreateMetaAttribute", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "summary": "Lists the available integration schemas.", + "operationId": "Schemas", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } } + } + }, + "post": { + "tags": [ + "Integration" ], + "summary": "Add an integration schema. Will fail if the schema is not valid, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "AddSchema", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" - } - } + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" - } - } + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" - } - } + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "examples": { - "Example 1": { - "summary": "Short text meta-attribute", - "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", - "value": { - "type": "shortText", - "isUnique": false, - "defaultThresholdType": "exists", - "name": "Short Label" - } - } + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } } } }, "responses": { "201": { - "description": "Created", + "description": "Created successfully", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "examples": { - "Example 25": { - "summary": "Date-time attribute", - "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", - "value": { - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "DAT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Casting Date", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "dateTime", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" - }, - "displayNames": { - "fr": "Casting Date French Display Name" - }, - "name": "Casting Date", - "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" - } - }, - "Example 26": { - "summary": "Discrete attribute", - "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "discreteType": { - "name": "MU Durability", - "guid": "00000083-0006-4fff-8fff-0000ffff0000" - }, - "isMultiValued": false, - "defaultThresholdType": "atLeast", - "helpPath": "html/attributenotes/metals.html", - "info": { - "typeCode": "DCT", - "chartable": false, - "expressionable": false, - "linkable": true, - "extendedName": "Metals", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 27": { - "summary": "Range attribute", - "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", - "value": { - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "defaultThresholdType": "atLeast", - "info": { - "typeCode": "RNG", - "chartable": true, - "expressionable": true, - "linkable": true, - "extendedName": "Tensile strength", - "isMetaAttribute": false, - "orderedMetaAttributes": [ - { - "type": "longText", - "displayNames": {}, - "name": "Notes", - "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" - } - ], - "standardNames": [ - { - "name": "Tensile strength", - "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [ - { - "name": "Source of data (MaterialUniverse)", - "guid": "06f485f1-4042-4843-bfea-898c1f50fa02" - } - ], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - } - }, - "Example 28": { - "summary": "Tabular attribute", - "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", - "value": { - "displayFullTable": false, - "displaySummaryRowInline": false, - "hideUnlinkedRows": true, - "target": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" - }, - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "shortText", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Chemical name", - "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" - }, - "showAsLink": true, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 0, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Substance name", - "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" - }, - { - "columnType": "localRange", - "defaultThresholdType": "atLeast", - "unit": { - "symbol": "%", - "guid": "00000005-0013-4fff-8fff-0000ffff0000" - }, - "showAsLink": false, - "summaryRowEnabled": false, - "summaryRowText": "", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "list", - "displayNames": {}, - "name": "Amount", - "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" - }, - { - "columnType": "linkedColumn", - "linkedAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - }, - "name": "Legislations restricting its use", - "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" - }, - "linkedColumn": { - "columnType": "linkedAttribute", - "linkedAttribute": { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" - }, - "name": "Rating", - "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "Substance ES&H rating", - "summaryRowTranslations": {}, - "order": 1, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" - }, - "linkedTarget": { - "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", - "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" - }, - "showAsLink": false, - "summaryRowEnabled": true, - "summaryRowText": "EH&S rating", - "summaryRowTranslations": {}, - "order": 2, - "rollUpType": "list", - "summaryRowRollUpType": "min", - "displayNames": {}, - "name": "Legislation rating", - "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - } - ], - "defaultThresholdType": "exists", - "info": { - "typeCode": "TABL", - "chartable": false, - "expressionable": false, - "linkable": false, - "extendedName": "Restricted substances associated with this material", - "isMetaAttribute": false, - "orderedMetaAttributes": [], - "standardNames": [ - { - "name": "Restricted substances in this item", - "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" - } - ], - "primaryDataLinkGroups": [], - "foreignDataLinkGroups": [], - "primarySmartLinkGroups": [], - "foreignSmartLinkGroups": [] - }, - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "displayNames": {}, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - } + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeCreationException" - }, - "example": { - "message": "Cannot create meta-attribute 'Notes'.", - "code": "attributeCreation", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "MetaAttribute with GUID 'efc1dc1d-c9d6-4116-9429-a226a1c06239' already exists.", - "guid": "efc1dc1d-c9d6-4116-9429-a226a1c06239", - "reason": "entityAlreadyExists", - "entityType": "metaAttribute" - } - ], - "reason": "namedEntity" - }, - { - "message": "Cannot have a meta-attribute as an 'About attribute'.", - "reason": "aboutAttributeCannotBeMeta" - } - ] + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } } } }, + "400": { + "description": "Bad request. Returns validation errors information" + }, "403": { - "description": "Forbidden" + "description": "Forbidden. User is not a global administrator or an administrator for the schema" }, - "404": { - "description": "Database, table or attribute not found" + "422": { + "description": "MI not in attribute-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": { - "post": { + "/v1alpha/integration-schemas/{schema}:search-index-status": { + "get": { "tags": [ - "Schema - Attributes" + "Integration" ], - "summary": "Validates the provided value against the attributes data rules.", - "operationId": "ValidateAttribute", + "summary": "Returns the status of a given integration schema.", + "operationId": "GetStatusForIntegrationSchema", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", + "name": "schema", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "attribute-guid", - "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "required": true, + "name": "include-errors", + "in": "query", "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "boolean" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/v1alpha/integration-schemas:search-index-status": { + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns the status of all available integration schemas.", + "operationId": "AllSchemaStatus", + "parameters": [ + { + "name": "include-errors", + "in": "query", + "schema": { + "type": "boolean" + } } - }, + ], "responses": { "200": { "description": "OK", "content": { + "text/plain": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeValidateResponse" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } + } + }, + "text/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/GsaIntegrationSchemaStatus" + } } } } }, - "400": { - "description": "Bad request" - }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database, table or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": { - "post": { + "/v1alpha/integration-schemas/{schema}": { + "put": { "tags": [ - "Schema - Attributes" + "Integration" ], - "summary": "Validates the provided value against the meta attributes data rules.", - "operationId": "ValidateMetaAttribute", + "summary": "Updates an integration schema.\r\nWill fail if the schema does not exist, is not valid, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "UpdateSchema", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "meta-attribute-guid", + "name": "schema", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", - "format": "uuid" + "type": "string" } } ], @@ -37990,1076 +18507,737 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaValidateAttributeRequest" + "$ref": "#/components/schemas/GsaGuidOnlyIntegrationSchemaOfObjectIdentifier" } } } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Updated successfully", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAttributeValidateResponse" + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } } } }, "400": { - "description": "Bad request" + "description": "Bad request. Returns validation errors information" }, "403": { - "description": "Forbidden" + "description": "Forbidden. User is not a global administrator or an administrator for the schema" }, "404": { - "description": "Database, table or meta-attribute not found" + "description": "Not Found. Schema does not exist" + }, + "422": { + "description": "MI not in attribute-based access control mode" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes:query": { - "post": { + }, + "delete": { "tags": [ - "Schema - Attributes" + "Integration" ], - "summary": "Get attributes in table, populate the requested properties. Optionally filter the returned attributes.", - "operationId": "QueryAttributes", + "summary": "Delete an integration schema. Will fail if the schema does not exist, or if the user is not both a global administrator and an administrator for the schema.", + "operationId": "DeleteSchema", "parameters": [ { - "name": "database-key", + "name": "schema", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Schema to be deleted", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } + } + ], + "responses": { + "204": { + "description": "Schema deleted" }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Schema not found" + } + } + }, + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns the full object representing the integration schema.\r\nNames and identities of source items will be populated if they can be found in the databases currently loaded in MI, otherwise just the GUIDs will be returned.", + "operationId": "GetSchema", + "parameters": [ { - "name": "table-guid", + "name": "schema", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The schema name.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "includeImplicitAttributes", + "in": "query", + "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "boolean" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } - } + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, - "examples": { - "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaIntegrationSchemaOfObjectIdentifier" + } + } + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/integration-schemas/{schema}/attributes": { + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns a list of the attributes defined in the integration schema.", + "operationId": "SchemaTargets", + "parameters": [ + { + "name": "schema", + "in": "path", + "description": "The schema name.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "includeImplicitAttributes", + "in": "query", + "description": "Whether to add in the schema attributes derived from certain record properties (e.g. Record Name) that are implicitly in all integration schemas. False by default.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" } - }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaIntegrationAttribute" } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } + } + } + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/integration-schemas/{schema}/sources/database/{database-key}/table/{table-identity}": { + "get": { + "tags": [ + "Integration" + ], + "summary": "Returns a list of the schema source mapping from the given table. Will fail if the database is not loaded in MI.\r\nNames and identities of source items will be populated.", + "operationId": "SchemaTableMappings", + "parameters": [ + { + "name": "schema", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-identity", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" } - }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSourceOfObjectIdentifier" } } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + } + }, + "404": { + "description": "Schema not found" + }, + "422": { + "description": "MI not in attribute-based access control mode" + } + } + } + }, + "/v1alpha/job-queue/jobs": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a list of jobs.", + "operationId": "GetJobs", + "parameters": [ + { + "name": "jobType", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "nameFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "descriptionFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "submitterNameFilter", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "pageNumber", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" + } }, - "examples": { - "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsResponse" } } + } + } + } + }, + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Create a new job.", + "operationId": "CreateJob", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Created successfully", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } }, - "examples": { - "Example 1": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 2": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 4": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 5": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 6": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 7": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + } + } + }, + "delete": { + "tags": [ + "JobQueue" + ], + "summary": "Delete specified jobs.", + "operationId": "DeleteJobs", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + }, + "application/*+json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" } - }, - "Example 8": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" } - }, - "Example 9": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" } } } } + }, + "422": { + "description": "No job IDs were specified" + }, + "500": { + "description": "Failed to delete one or more jobs" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get job by ID.", + "operationId": "GetJob", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + }, + "patch": { + "tags": [ + "JobQueue" + ], + "summary": "Update a job.", + "operationId": "UpdateJob", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateJobRequest" + } + } } }, "responses": { "200": { "description": "OK", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + }, + "delete": { + "tags": [ + "JobQueue" + ], + "summary": "Delete a job.", + "operationId": "DeleteJob", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Success - no content" + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}:retrieve-definition": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a job creation object based on an existing job.", + "operationId": "RestoreJob", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateJobRequest" } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" }, "404": { - "description": "Table not found" + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}:move-to-top": { + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Move a job to the top of the queue (actually sets the scheduled execution date to now, could be done with patch method).", + "operationId": "MoveToTop", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Job not found" } } } }, - "/v1alpha/databases/{database-key}/attributes:query": { + "/v1alpha/job-queue/jobs/{id}:resubmit": { "post": { "tags": [ - "Schema - Attributes" + "JobQueue" ], - "summary": "Get attributes in database, populate the requested properties. Optionally filter the returned attributes.", - "operationId": "QueryAttributesInDatabase", + "summary": "Resubmit a job.", + "operationId": "Resubmit", "parameters": [ { - "name": "database-key", + "name": "id", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "format": "uuid" } } ], @@ -39067,903 +19245,568 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } - } - } + "$ref": "#/components/schemas/GsaResubmitJobRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaResubmitJobRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } - } - }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaJob" + } + } + } + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/files": { + "post": { + "tags": [ + "JobQueue" + ], + "summary": "Uploads an ephemeral file and returns an ID which can subsequently be used to refer to that file in a job creation request. Ephemeral files have a short lifespan\r\nand should be used to provide file data to jobs only. They should not be used as file storage.", + "operationId": "UploadFile", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" } } + }, + "encoding": { + "file": { + "style": "form" + } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "string" + } }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } - } - }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] - } - } - }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } - } + "application/json": { + "schema": { + "type": "string" + } + }, + "text/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}/outputs": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get a job's output filenames.", + "operationId": "GetOutputFilenames", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" } - }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" } - }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", - "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} - } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" } } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + } + }, + "404": { + "description": "Job not found" + } + } + } + }, + "/v1alpha/job-queue/jobs/{id}/outputs:export": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Retrieve a job output file.", + "operationId": "GetJobOutputFile", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "fileName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "404": { + "description": "Job or file not found" + } + } + } + }, + "/v1alpha/job-queue/current-user": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get the current user.", + "operationId": "GetCurrentUser", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } }, - "examples": { - "Example 10": { - "summary": "Fetch all attributes with unit and meta attributes", - "value": { - "properties": { - "type": true, - "info": { - "orderedMetaAttributes": { - "type": true, - "name": true - } - }, - "unit": { - "symbol": true - }, - "name": true, - "guid": true - } - } - }, - "Example 11": { - "summary": "Fetch all attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "helpPath": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true, - "orderedMetaAttributes": { - "type": true, - "name": true, - "guid": true - } - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCurrentUser" + } + } + } + } + } + } + }, + "/v1alpha/job-queue/processing-configuration": { + "get": { + "tags": [ + "JobQueue" + ], + "summary": "Get the processing configuration.", + "operationId": "GetProcessingConfig", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaProcessingConfig" + } + } + } + } + } + } + }, + "/v1alpha/license/user-license:ensure-checked-out": { + "get": { + "tags": [ + "License" + ], + "summary": "Either checks out a user license for the requesting user, or returns an error response if no such license is available.\r\nThis method is a no-op because it relies on license check to happen within Granta.Server.Api.Auth.UserContextFilter", + "operationId": "EnsureUserLicenseAvailable", + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/MicrosoftAspNetCoreMvcObjectResult" + } + } + } + } + } + } + }, + "/v1alpha/license/server-licenses:ensure-checked-out": { + "post": { + "tags": [ + "License" + ], + "summary": "Checks out server wide licenses and returns a bool for each provided app name indicating if\r\nthe relevant license(s) required have been checked out.", + "operationId": "CheckoutAppLicense", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "value": { + "appNames": [ + "MI BoM Analyzer" + ] } }, - "Example 12": { - "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "link" - ] - } + "appNames": [ + "RS Reports", + "Sustainability Analytics" + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "value": { + "appNames": [ + "MI BoM Analyzer" + ] } }, - "Example 13": { - "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } + "appNames": [ + "RS Reports", + "Sustainability Analytics" + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "value": { + "appNames": [ + "MI BoM Analyzer" + ] } }, - "Example 14": { - "summary": "Fetch attribute with name \"Young's modulus\"", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Young's modulus" - ] - } + "appNames": [ + "RS Reports", + "Sustainability Analytics" + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutRequest" + }, + "examples": { + "Example 1": { + "summary": "License request", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses required to use BoM Analyzer are checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", + "value": { + "appNames": [ + "MI BoM Analyzer" + ] } }, - "Example 15": { - "summary": "Fetch attributes with matching GUID", - "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "Example 2": { + "summary": "License request with multiple application names", + "description": "This example demonstrates a request to the endpoint to check if the relevant licenses for each application name have been checked out. This endpoint currently does not support all application names and unsupported names will not be returned in the response.", "value": { - "properties": { - "type": true, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "0000003f-0001-4fff-8fff-dd92ffff0000", - "000000e3-0001-4fff-8fff-dd92ffff0000" - ] + "appNames": [ + "RS Reports", + "Sustainability Analytics" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAppNameLicenseCheckoutResponse" + } + } + } + } + } + } + }, + "/v1alpha/license/server-licenses": { + "get": { + "tags": [ + "License" + ], + "summary": "Get info on which server licenses are enabled, and the license expiry date.", + "operationId": "GetServerLicense", + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaEnabledLicensesInfo" + } + } + } + } + } + } + }, + "/api/v1/lists/audit/search": { + "post": { + "tags": [ + "ListAuditLog" + ], + "summary": "Posts a search request, and returns an object containing search result identifier", + "operationId": "RunListAuditLogSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", + "value": { + "listIdentifiers": [ + "ebd3e82c-0b32-4fc5-9f62-bb6dd09e01fd" + ], + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" + ], + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 } } - }, - "Example 16": { - "summary": "Fetch attributes with discrete type by name", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "name": [ - "MU Durablity" - ] - } + "listIdentifiers": [ + "ebd3e82c-0b32-4fc5-9f62-bb6dd09e01fd" + ], + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" + ], + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 } } - }, - "Example 17": { - "summary": "Fetch attributes with discrete type by GUID", - "description": "This example demonstrates how to find attributes with discrete type 'MU Durability' in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "discreteType": { - "guid": [ - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "listIdentifiers": [ + "ebd3e82c-0b32-4fc5-9f62-bb6dd09e01fd" + ], + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" + ], + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 } } - }, - "Example 18": { - "summary": "Fetch attributes with any discrete type", - "description": "This example demonstrates how to find attributes with any discrete type in database 'MI Training'. It could be run in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'), or across the whole database", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaListAuditLogSearchRequest" + }, + "examples": { + "Example 1": { + "summary": "Record list audit log search", + "description": "Search for the audit log items for the first 10 times the given list had an item added or removed", "value": { - "properties": { - "discreteType": { - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "discreteType": {} + "listIdentifiers": [ + "ebd3e82c-0b32-4fc5-9f62-bb6dd09e01fd" + ], + "listActionsToInclude": [ + "ItemAdded", + "ItemRemoved" + ], + "pagingOptions": { + "startIndex": 0, + "pageSize": 10 } } } @@ -39972,12 +19815,202 @@ } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/audit/search/results/{resultResourceIdentifier}": { + "get": { + "tags": [ + "ListAuditLog" + ], + "summary": "Returns the search results found in the specified resource", + "operationId": "GetListAuditLogSearchResults", + "parameters": [ + { + "name": "resultResourceIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaListAuditLogItem" + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/items": { + "get": { + "tags": [ + "ListItem" + ], + "summary": "Returns the items in the given list", + "operationId": "GetListItems", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/items/add": { + "post": { + "tags": [ + "ListItem" + ], + "summary": "Adds the specified items to an existing list.", + "operationId": "AddItemsToList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordListItemsInfo" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" } } } @@ -39989,63 +20022,352 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Record list not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query": { + "/api/v1/lists/list/{listIdentifier}/items/remove": { "post": { "tags": [ - "Schema - Attributes" + "ListItem" ], - "summary": "Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributes", + "summary": "Removed the specified items from an existing list.", + "operationId": "RemoveItemsFromList", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDeleteRecordListItems" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListItemsInfo" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns all lists visible to the calling user", + "operationId": "GetAllLists", + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeadersInfo" + } + } + } + }, + "403": { + "description": "Forbidden" + } + } + }, + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Creates a new list with the specified properties and items.", + "operationId": "CreateList", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateRecordList" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/search": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Posts a search request, and returns an object containing search result identifier", + "operationId": "RunRecordListsSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchInfo" + } + } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/api/v1/lists/search/results/{resultResourceIdentifier}": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns the search results found in the specified resource", + "operationId": "GetRecordListSearchResults", + "parameters": [ { - "name": "table-guid", + "name": "resultResourceIdentifier", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListSearchResultsInfo" + } + } + } + }, + "403": { + "description": "Forbidden" }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}": { + "get": { + "tags": [ + "ListManagement" + ], + "summary": "Returns the given list if it exists and the calling user has read access to it", + "operationId": "GetList", + "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "name": "listIdentifier", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } } }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + }, + "patch": { + "tags": [ + "ListManagement" + ], + "summary": "Performs a partial update on the properties of a list.", + "operationId": "UpdateList", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "listIdentifier", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -40053,641 +20375,219 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", + "summary": "Update the name of list", + "description": "Update the name of a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", + "summary": "Update the name of list", + "description": "Update the name of a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", + "summary": "Update the name of list", + "description": "Update the name of a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListProperties" }, "examples": { "Example 1": { - "summary": "Fetch all meta-attributes", + "summary": "Update the name of list", + "description": "Update the name of a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } + "name": "new name", + "published": false, + "awaitingApproval": false, + "internalUse": false } }, "Example 2": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 3": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 4": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 5": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "summary": "Update everything for a list", + "description": "Update everything for a list", "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } + "name": "new name", + "description": "new description", + "notes": "new notes", + "published": false, + "awaitingApproval": true, + "internalUse": true } } } } } - }, + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + }, + "delete": { + "tags": [ + "ListManagement" + ], + "summary": "Delete an existing list.", + "operationId": "DeleteList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { "200": { - "description": "OK", + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/request-approval": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Update the status of an existing list to \"awaiting approval\".", + "operationId": "RequestApproval", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } } } @@ -40699,694 +20599,473 @@ "description": "Forbidden" }, "404": { - "description": "Table not found" + "description": "Record list not found" } } } }, - "/v1alpha/databases/{database-key}/meta-attributes:query": { + "/api/v1/lists/list/{listIdentifier}/reset": { "post": { "tags": [ - "Schema - Attributes" + "ListManagement" ], - "summary": "Get meta-attributes in database, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributesInDatabase", + "summary": "Update the status of an existing list to not be \"awaiting approval\".", + "operationId": "ResetAwaitingApproval", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/publish": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Update the status of an existing list to \"published\". The list must be awaiting approval, and not already published.\r\nThe \"awaiting approval\" flag will be reset to false.", + "operationId": "PublishList", + "parameters": [ { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "name": "listIdentifier", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/unpublish": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Update the status of an existing list to \"unpublished\". The list must be published, and awaiting approval.\r\nThe \"awaiting approval\" flag will be reset to false.", + "operationId": "UnpublishList", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "listIdentifier", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } }, - "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, - "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/revise": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Creates a private copy of a list that can be revised.", + "operationId": "ReviseList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/copy": { + "post": { + "tags": [ + "ListManagement" + ], + "summary": "Creates a copy of the list and its items", + "operationId": "CopyList", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } }, - "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListHeader" } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/permissions/subscribe": { + "post": { + "tags": [ + "ListPermissions" + ], + "summary": "Subscribes the calling user to the specified list.", + "operationId": "Subscribe", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } }, - "examples": { - "Example 6": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 7": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 8": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 9": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 10": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/permissions/unsubscribe": { + "post": { + "tags": [ + "ListPermissions" + ], + "summary": "Unsubscribes the calling user from the specified list.", + "operationId": "Unsubscribe", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermission" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + }, + "422": { + "description": "Unsubscribe Failed" + } + } + } + }, + "/api/v1/lists/list/{listIdentifier}/permissions": { + "get": { + "tags": [ + "ListPermissions" + ], + "summary": "Gets all permissions associated with the specified list.", + "operationId": "GetPermissions", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermissionsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermissionsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list not found" + } + } + }, + "post": { + "tags": [ + "ListPermissions" + ], + "summary": "Sets permissions for the specified list. Returns a collection of the created/updated permissions.", + "operationId": "SetPermissions", + "parameters": [ + { + "name": "listIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateUserPermissionsInfo" + } + } } }, "responses": { - "200": { - "description": "OK", + "202": { + "description": "Accepted", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermissionsInfo" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaUserPermissionsInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUserPermissionsInfo" } } } @@ -41398,74 +21077,90 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Record list or user or group not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query": { - "post": { + "/api/v1/lists/list/{listIdentifier}/permissions/user/{userIdentifier}": { + "get": { "tags": [ - "Schema - Attributes" + "ListPermissions" ], - "summary": "Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes.", - "operationId": "QueryMetaAttributesForAttribute", + "summary": "Gets the permission flags of the permission associating the specified list with the specified user.", + "operationId": "GetPermissionsForUser", "parameters": [ { - "name": "database-key", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "userIdentifier", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } + } + } }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "User or group, record list or record list permission not found" + } + } + }, + "put": { + "tags": [ + "ListPermissions" + ], + "summary": "Sets the permission flags of the permission associating the specified list with the specified user.", + "operationId": "SetPermissionsForUser", + "parameters": [ { - "name": "attribute-guid", + "name": "listIdentifier", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "userIdentifier", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -41473,697 +21168,410 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } - }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] - } - } - } + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateRecordListPermissionFlags" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } }, - "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordListPermissionFlags" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Record list or user or group not found" + } + } + } + }, + "/v1alpha/metrics/jobs": { + "get": { + "tags": [ + "Metrics" + ], + "summary": "Get a summary of jobs currently running or completed since the start time.", + "operationId": "GetJobsSummary", + "parameters": [ + { + "name": "start", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaGetJobsSummaryResponse" + } + } + } + } + } + } + }, + "/v1alpha/databases/{database-key}/permission-categories": { + "get": { + "tags": [ + "Permission-Based Access Control" + ], + "summary": "Get all permission-based access control categories for the specified database.", + "operationId": "GetPermissionCategories", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPermissionCategoriesInfo" }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "categories": [ + { + "name": "Geo", + "guid": "22b3fb02-d5e6-4604-9ebd-95715046bed9" }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + { + "name": "Sensitivity", + "guid": "92607b1a-dba4-43f0-953a-aacac2341596" }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] + { + "name": "Division", + "guid": "872a9491-342c-4741-8c3f-d1e028560152" } - } + ] } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + }, + "422": { + "description": "MI not in permission-based access control mode" + } + } + } + }, + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}": { + "get": { + "tags": [ + "Permission-Based Access Control" + ], + "summary": "Get a permission-based access control category with a specified guid.", + "operationId": "GetPermissionCategory", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "category-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPermissionCategory" }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "permissions": [ + { + "name": "US", + "guid": "6363563e-e790-4ae4-a2d3-89f7c5411502" }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + { + "name": "EMEA", + "guid": "4f917827-10d4-4b76-8e15-3cb4fb00fd75" }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] + { + "name": "APAC", + "guid": "dad32f97-2c00-4263-bd81-4a074ac92407" } - } + ], + "name": "Geo", + "guid": "22b3fb02-d5e6-4604-9ebd-95715046bed9" } } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesRequest" - }, - "examples": { - "Example 11": { - "summary": "Fetch all meta-attributes", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true - } - } - }, - "Example 12": { - "summary": "Fetch all meta-attributes with custom properties", - "value": { - "properties": { - "isProtected": true, - "type": true, - "defaultThresholdType": true, - "isHiddenFromSearchCriteria": true, - "isMultiValued": true, - "isFunctionalRange": true, - "axisName": { - "name": true, - "displayNames": true - }, - "info": { - "chartable": true - }, - "unit": { - "name": true, - "symbol": true, - "relativeSymbol": true, - "equation": true, - "guid": true - }, - "discreteType": { - "isOrdered": true, - "name": true, - "guid": true - }, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true, - "guid": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "target": { - "targetDatabaseGuid": true, - "targetDatabaseVersionGuid": true, - "targetTableGuid": true, - "targetAttributeGuid": true - }, - "tabularColumns": { - "linkedAttributeGuid": true, - "linkedColumnGuid": true, - "name": true, - "guid": true - }, - "attributeParameters": { - "name": true, - "guid": true - }, - "expressions": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } - } - }, - "Example 13": { - "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", - "value": { - "properties": { - "type": true, - "isHiddenFromSearchCriteria": true, - "dataRule": { - "description": true, - "regularExpression": true, - "name": true - }, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "type": [ - "shortText", - "longText" - ] - } - } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or category not found" + }, + "422": { + "description": "MI not in permission-based access control mode" + } + } + } + }, + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions": { + "get": { + "tags": [ + "Permission-Based Access Control" + ], + "summary": "Get all permission-based access control permissions for the specified category.", + "operationId": "GetPermissionsInCategory", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "category-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaPermissionsInfo" }, - "Example 14": { - "summary": "Fetch meta-attributes with name \"Notes\"", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + "example": { + "permissions": [ + { + "name": "US", + "guid": "6363563e-e790-4ae4-a2d3-89f7c5411502" }, - "filter": { - "name": [ - "Notes" - ] - } - } - }, - "Example 15": { - "summary": "Fetch meta-attributes with matching GUID", - "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", - "value": { - "properties": { - "type": true, - "aboutAttribute": { - "type": true, - "name": true, - "guid": true - }, - "name": true, - "guid": true + { + "name": "EMEA", + "guid": "4f917827-10d4-4b76-8e15-3cb4fb00fd75" }, - "filter": { - "guid": [ - "05dc05c6-7e15-4790-81e2-34d4ea8750a8" - ] + { + "name": "APAC", + "guid": "dad32f97-2c00-4263-bd81-4a074ac92407" } - } + ] } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or category not found" + }, + "422": { + "description": "MI not in permission-based access control mode" + } + } + } + }, + "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}": { + "get": { + "tags": [ + "Permission-Based Access Control" + ], + "summary": "Get a permission-based access control permission with a given guid in the specified category.", + "operationId": "GetPermissionInCategory", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "category-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "permission-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } - }, + ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryAttributesInfo" + "$ref": "#/components/schemas/GsaPermission" + }, + "example": { + "role": "DOMAIN\\US", + "description": "Members of the US role", + "setMessage": "Permission set", + "unsetMessage": "No permission set", + "name": "US", + "guid": "6363563e-e790-4ae4-a2d3-89f7c5411502" } } } }, - "400": { - "description": "Bad request" - }, "403": { "description": "Forbidden" }, "404": { - "description": "Attribute not found" + "description": "Database or category or permission not found" + }, + "422": { + "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}": { "get": { "tags": [ - "Schema - Attributes" + "Records - Record Histories" ], - "summary": "Get permission-based access control settings for a given attribute.\r\nReturns the access control for each permission in each category.", - "operationId": "GetAttributePermissionCategoryAccessControls", + "summary": "Get a record history with a specified guid for a given database and table.", + "operationId": "GetRecordHistoryFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "attribute-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { @@ -42172,112 +21580,162 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "categoryAccessControls": [ + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" } - ] + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database, table or record history not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}": { + "get": { "tags": [ - "Schema - Attributes" + "Records - Record Histories" ], - "summary": "Update permission-based access control settings for a given attribute.\r\nSets the access control for the given permissions.", - "operationId": "UpdateAttributePermissionCategoryAccessControls", + "summary": "Get a record history with a specified guid for a given database.", + "operationId": "GetRecordHistory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "attribute-guid", + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRecordHistory" + }, + "example": { + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + } + } + } + }, + "404": { + "description": "Database or record history not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories": { + "post": { + "tags": [ + "Records - Record Histories" + ], + "summary": "Create a new record history.", + "operationId": "CreateRecordHistory", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Attributes/GetAttributes](#/Schema%20-%20Attributes/GetAttributes) or [Schema - Attributes/QueryAttributes](#/Schema%20-%20Attributes/QueryAttributes)", "format": "uuid" } } @@ -42286,340 +21744,248 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "c1e9cda5-4544-4007-a540-3aec40c1fa0d" } }, "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "c1e9cda5-4544-4007-a540-3aec40c1fa0d" } }, "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "c1e9cda5-4544-4007-a540-3aec40c1fa0d" } }, "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaCreateRecordHistory" }, "examples": { + "Example 1": { + "summary": "Record History", + "description": "This example demonstrates how to create a new record history at the root of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordType": "record", + "name": "New Record Name" + } + }, + "Example 2": { + "summary": "Record History with Tree Name and Parent", + "description": "This example demonstrates how to create a new record history with a specified tree name under the 'Alumino Silicate' folder (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "record", + "name": "Alumino Silicate - 1756", + "shortName": "1756", + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + }, "Example 3": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "summary": "Record History for a 'folder' with specified guid", + "description": "This example demonstrates how to create a new 'folder' with no 'tree name' (so is set to the 'full name') and a specified guid under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "guid": "c1e9cda5-4544-4007-a540-3aec40c1fa0d" } }, "Example 4": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "summary": "Record History with specified color", + "description": "This example demonstrates how to create a new 'folder' with a specified color under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "recordType": "folder", + "name": "Borosilicate", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordColor": "lime" + } + }, + "Example 5": { + "summary": "Record History for a 'generic'", + "description": "This example demonstrates how to create a new 'generic' under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "recordType": "generic", + "name": "Soda-zinc", + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } } } @@ -42627,255 +21993,83 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + }, + "recordVersions": [ { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "versionNumber": 1, + "versionState": "unversioned", + "name": "New Alumino Silicate Record", + "guid": "2969de62-6eda-43b8-a1ca-320fd703f6ef" } - ] + ], + "subsets": [], + "guid": "533270e9-3b46-4adb-ac00-feae73744556" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 5": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID 'fb550801-597c-496c-958c-3ebfeaa6254a', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID 'fb550801-597c-496c-958c-3ebfeaa6254a' does not exist.", - "categoryGuid": "fb550801-597c-496c-958c-3ebfeaa6254a", - "reason": "noSuchCategory" - } - ] - } - }, - "Example 6": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '44c258b2-5dad-4ce5-bf68-98586ad7b9b1' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '44c258b2-5dad-4ce5-bf68-98586ad7b9b1' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "permissionGuid": "44c258b2-5dad-4ce5-bf68-98586ad7b9b1", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "reason": "noSuchPermission" - } - ] - } - }, - "Example 7": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ], - "reason": "duplicateCategoryGuids" - } - ] - } - }, - "Example 8": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ], - "reason": "duplicatePermissionGuids" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or attribute not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:move": { + "post": { "tags": [ - "Schema - Configurations" + "Records - Record Histories" ], - "summary": "Get all configurations of given type", - "operationId": "GetConfigurations", + "summary": "Move a record history to be under a new parent.", + "operationId": "MoveRecordHistoryInTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConfigurationsInfo" - }, - "example": { - "configurations": [ - { - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" - } - ] - } - } - } }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Create a new configuration.", - "operationId": "CreateConfiguration", - "parameters": [ { - "name": "database-key", + "name": "table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "configuration-type", + "name": "record-history-guid", "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -42883,118 +22077,125 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "85b36093-4eef-4a2f-a913-8f02aab17310" - } + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "85b36093-4eef-4a2f-a913-8f02aab17310" - } + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "85b36093-4eef-4a2f-a913-8f02aab17310" - } + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { "Example 1": { - "summary": "Configuration", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, "Example 2": { - "summary": "Configuration with specified guid and description", - "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "description": "Basic configuration that can be used in explore.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "basic configuration", - "guid": "85b36093-4eef-4a2f-a913-8f02aab17310" - } + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } } } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConfiguration" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" } } } @@ -43004,30 +22205,70 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "$ref": "#/components/schemas/GsaRecordHistoryMoveException" }, "examples": { "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Explore Configuration file with the name 'examples', but there is already a file with that name.", + "summary": "New parent is not a folder.", "value": { - "message": "Cannot create Configuration file 'examples'.", - "code": "fileCreation", - "name": "examples", - "folderType": "configuration", + "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'examples' already exists in this Folder.", - "name": "examples", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] + } + }, + "Example 2": { + "summary": "New parent is not in the same table.", + "value": { + "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" + } + ] + } + }, + "Example 3": { + "summary": "The 'short name' of the record to be moved is not unique under the new parent.", + "value": { + "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ + { + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" + } + ] + } + }, + "Example 4": { + "summary": "New parent is withdrawn.", + "value": { + "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] + } + }, + "Example 5": { + "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", + "value": { + "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", + "reason": "ParentIsADescendant" } ] } @@ -43040,117 +22281,29 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or record history not found" } } } }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": { - "get": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Get individual configuration", - "operationId": "GetConfiguration", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], - "type": "string" - } - }, - { - "name": "configuration-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConfiguration" - }, - "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" - } - } - } - }, - "404": { - "description": "Database or configuration not found" - } - } - }, - "patch": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:move": { + "post": { "tags": [ - "Schema - Configurations" + "Records - Record Histories" ], - "summary": "Update a configuration.", - "operationId": "UpdateConfiguration", + "summary": "Move a record history to be under a new parent.", + "operationId": "MoveRecordHistory", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "record-history-guid", "in": "path", "required": true, "schema": { @@ -43163,97 +22316,85 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "bb55f5c1-d14f-4ed1-ae81-7b20249cf852" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, - "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", - "value": { - "name": "examples (updated)" - } + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "bb55f5c1-d14f-4ed1-ae81-7b20249cf852" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, - "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", - "value": { - "name": "examples (updated)" - } + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "bb55f5c1-d14f-4ed1-ae81-7b20249cf852" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, - "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", - "value": { - "name": "examples (updated)" - } + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConfiguration" + "$ref": "#/components/schemas/GsaMoveRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a configuration", - "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 3": { + "summary": "Move Record History", + "description": "This example demonstrates how to move an existing record history to under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "Updated description for MI_Training Explore 'examples' configuration.", - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples (updated)", - "guid": "bb55f5c1-d14f-4ed1-ae81-7b20249cf852" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + } } }, - "Example 2": { - "summary": "Update a name", - "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", - "value": { - "name": "examples (updated)" - } + "Example 4": { + "summary": "Move Record History to be directly under the Table.", + "description": "In order to move an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", + "value": {} } } } @@ -43265,12 +22406,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConfiguration" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", - "name": "examples", - "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" } } } @@ -43280,22 +22444,70 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" + "$ref": "#/components/schemas/GsaRecordHistoryMoveException" }, "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a Configuration file to ''.", + "Example 6": { + "summary": "New parent is not a folder.", + "value": { + "message": "Cannot move record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" + } + ] + } + }, + "Example 7": { + "summary": "New parent is not in the same table.", + "value": { + "message": "Cannot move record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" + } + ] + } + }, + "Example 8": { + "summary": "The 'short name' of the record to be moved is not unique under the new parent.", + "value": { + "message": "Cannot move record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, + "errors": [ + { + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" + } + ] + } + }, + "Example 9": { + "summary": "New parent is withdrawn.", "value": { - "message": "Cannot update Configuration file with GUID 'ae8e17eb-92f5-4310-9c63-72040482984a'.", - "code": "fileUpdate", - "fileGuid": "ae8e17eb-92f5-4310-9c63-72040482984a", - "folderType": "configuration", + "message": "Cannot move record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] + } + }, + "Example 10": { + "summary": "The new parent is a descendant of the record history to be moved so would cause a circular reference in the hierarchy.", + "value": { + "message": "Cannot move record history with GUID '5a842e54-e143-45f5-aec8-18fb84f4fe03'.", + "code": 400, "errors": [ { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" + "message": "New parent record history (GUID = 'ba22491d-b470-42cf-80d7-531ff81b1583') is a descendant so will cause a circular reference.", + "reason": "ParentIsADescendant" } ] } @@ -43308,457 +22520,188 @@ "description": "Forbidden" }, "404": { - "description": "Database or configuration not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Delete a configuration", - "operationId": "DeleteConfiguration", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], - "type": "string" - } - }, - { - "name": "configuration-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or configuration not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:export": { - "get": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Get configurations as a zip file", - "operationId": "ExportConfigurations", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/zip": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "404": { - "description": "Database not found" + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}:copy": { + "post": { "tags": [ - "Schema - Configurations" + "Records - Record Histories" ], - "summary": "Get individual configuration as a file", - "operationId": "ExportConfiguration", + "summary": "Make a copy of a record history.", + "operationId": "CopyRecordHistoryInTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", "required": true, "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], "type": "string" } }, { - "name": "configuration-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true - }, - "404": { - "description": "Database or configuration not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/configurations/{configuration-type}:descendants": { - "get": { - "tags": [ - "Schema - Configurations" - ], - "summary": "Returns file information for all configurations for the specified type.", - "operationId": "GetDescendants", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "configuration-type", - "in": "path", - "description": "The configuration type as entered.", - "required": true, - "schema": { - "enum": [ - "explore", - "proExplore", - "bomAnalyzer", - "materialModelPicker", - "landingPages", - "dependentDiscretes", - "findSimilar" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/constants": { - "get": { - "tags": [ - "Schema - Constants" - ], - "summary": "Get all constants", - "operationId": "GetConstants", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConstantsInfo" - }, - "example": { - "constants": [ - { - "value": 3.1415901184082031, - "name": "PI", - "guid": "00000001-0004-4fff-8fff-0000ffff0000" - }, - { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" - } - ] - } - } - } }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Constants" - ], - "summary": "Create a new constant.", - "operationId": "CreateConstant", - "parameters": [ { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "Database in which constant will be created", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "requestBody": { - "description": "Constant to add to database", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "7306719c-5874-4fde-a371-91bd497e074e" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "7306719c-5874-4fde-a371-91bd497e074e" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "7306719c-5874-4fde-a371-91bd497e074e" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { "Example 1": { - "summary": "Constant", - "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, "Example 2": { - "summary": "Constant with specified guid", - "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "value": 0.0072973525693, - "name": "fine-structure constant (guid)", - "guid": "7306719c-5874-4fde-a371-91bd497e074e" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, "Example 3": { - "summary": "Constant with specified unit", - "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum (guid and unit)" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } @@ -43771,16 +22714,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "39fe970e-63b3-4e6a-bd36-3ca2a57bb7c9" } } } @@ -43790,77 +22752,59 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstantCreationException" + "$ref": "#/components/schemas/GsaRecordHistoryCopyException" }, "examples": { "Example 1": { - "summary": "Name already exists", - "description": "A constant with the same name already exists in the database.", + "summary": "New parent is not a folder.", "value": { - "message": "Cannot create constant 'Speed of light'.", - "code": "constantCreation", - "name": "Speed of light", + "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Constant with name 'Speed of light' already exists.", - "name": "Speed of light", - "reason": "nameAlreadyExists", - "entityType": "constant" - } - ], - "reason": "namedEntity" + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" } ] } }, "Example 2": { - "summary": "GUID already exists", - "description": "A constant with the same GUID already exists in the database.", + "summary": "New parent is not in the same table.", "value": { - "message": "Cannot create constant 'NewConstant'.", - "code": "constantCreation", - "name": "NewConstant", + "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Constant with GUID '0000000f-0004-4fff-8fff-0000ffff0000' already exists.", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000", - "reason": "entityAlreadyExists", - "entityType": "constant" - } - ], - "reason": "namedEntity" + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" } ] } }, "Example 3": { - "summary": "Unit not found", - "description": "The specified unit GUID does not exist in the database.", + "summary": "The 'short name' of the record to be copied is not unique under the new parent.", "value": { - "message": "Cannot create constant 'NewConstant'.", - "code": "constantCreation", - "name": "NewConstant", + "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, "errors": [ { - "message": "Could not find unit with GUID 'f5b34d19-34e6-4658-943b-4c35966aeae8'.", - "guid": "f5b34d19-34e6-4658-943b-4c35966aeae8", - "reason": "noSuchUnit" + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" } ] } }, "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", + "summary": "New parent is withdrawn.", "value": { - "message": "CreateConstant: Required property 'name' not found in JSON", - "code": "jsonSerialization" + "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ + { + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" + } + ] } } } @@ -43871,88 +22815,30 @@ "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database, table or record history not found" } } } }, - "/v1alpha/databases/{database-key}/constants/{constant-guid}": { - "get": { - "tags": [ - "Schema - Constants" - ], - "summary": "Get individual constant", - "operationId": "GetConstant", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which constant will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "constant-guid", - "in": "path", - "description": "Guid of requested constant", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConstant" - }, - "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" - }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" - } - } - } - }, - "404": { - "description": "Database or constant not found" - } - } - }, - "patch": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}:copy": { + "post": { "tags": [ - "Schema - Constants" + "Records - Record Histories" ], - "summary": "Update constant.", - "operationId": "UpdateConstant", + "summary": "Make a copy of a record history.", + "operationId": "CopyRecordHistory", "parameters": [ { "name": "database-key", "in": "path", - "description": "Database in which constant will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "constant-guid", + "name": "record-history-guid", "in": "path", - "description": "Guid of constant to update", "required": true, "schema": { "type": "string", @@ -43961,132 +22847,147 @@ } ], "requestBody": { - "description": "Constant data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "d62827d4-6f3c-4f09-be68-071c4df5f8dc" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "characteristic impedance of vacuum" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, - "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7895a95e-b0ee-4c6d-92fb-6ea0958fea95" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "d62827d4-6f3c-4f09-be68-071c4df5f8dc" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "characteristic impedance of vacuum" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, - "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7895a95e-b0ee-4c6d-92fb-6ea0958fea95" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "d62827d4-6f3c-4f09-be68-071c4df5f8dc" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "characteristic impedance of vacuum" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, - "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7895a95e-b0ee-4c6d-92fb-6ea0958fea95" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateConstant" + "$ref": "#/components/schemas/GsaCopyRecordHistory" }, "examples": { - "Example 1": { - "summary": "Everything for a constant", - "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 4": { + "summary": "Copy Record History - no name change - add new record to the new parent's subsets", + "description": "This example demonstrates how to copy an existing record history, by default the 'name' and 'short name' are not changed. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "value": 376.730313668, - "name": "characteristic impedance of vacuum", - "guid": "d62827d4-6f3c-4f09-be68-071c4df5f8dc" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromParent" } }, - "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 5": { + "summary": "Copy Record History - with name change - add new record to the original record's subsets", + "description": "This example demonstrates how to copy an existing record history and change the 'short name' of the newly created record version. The the new record history is created under the 'Glasses' folder (guid = f92315e2-f836-4c2e-aba1-6d8a1a49e8a3) of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "characteristic impedance of vacuum" + "newParent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "subsetOption": "fromOriginalRecord", + "newShortName": "Short name for new record" } }, - "Example 3": { - "summary": "Update guid and unit", - "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "Example 6": { + "summary": "Copy Record History to be directly under the Table - don't copy any subsets.", + "description": "In order to copy an existing record history to be at the top of the 'record tree' i.e directly under the 'Table' then do not specify the 'NewParent' property.", "value": { - "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", - "guid": "7895a95e-b0ee-4c6d-92fb-6ea0958fea95" + "subsetOption": "none", + "newShortName": "Short name for new record" } } } @@ -44094,21 +22995,40 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaRecordHistory" }, "example": { - "unit": { - "symbol": "m/s", - "guid": "00000097-0013-4fff-8fff-0000ffff0000" + "isFolder": false, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "value": 300000000.0, - "name": "Speed of Light in Vacuum", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + "parent": { + "guid": "f92315e2-f836-4c2e-aba1-6d8a1a49e8a3" + }, + "recordVersions": [ + { + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" + } + ], + "subsets": [ + { + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + } + ], + "guid": "b3b1a530-6a02-4dd0-a4d8-f1da0c8053d6" } } } @@ -44118,483 +23038,128 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaConstantUpdateException" + "$ref": "#/components/schemas/GsaRecordHistoryCopyException" }, "examples": { - "Example 1": { - "summary": "Name already exists", - "description": "A constant with the same name already exists in the database.", + "Example 5": { + "summary": "New parent is not a folder.", "value": { - "message": "Cannot update constant with GUID 'ccf1af5e-5410-4438-a52d-e42f3716a3f9'.", - "code": "constantUpdate", - "constantGuid": "ccf1af5e-5410-4438-a52d-e42f3716a3f9", + "message": "Cannot copy record history with GUID 'ba22491d-b470-42cf-80d7-531ff81b1583'.", + "code": 400, "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Constant with name 'Speed of light' already exists.", - "name": "Speed of light", - "reason": "nameAlreadyExists", - "entityType": "constant" - } - ], - "reason": "namedEntity" + "message": "New parent record history (GUID = '17877254-3a26-4a28-94d6-9f6be164914c') is not a folder.", + "reason": "ParentNotAFolder" } ] } }, - "Example 2": { - "summary": "GUID already exists", - "description": "A constant with the same GUID already exists in the database.", + "Example 6": { + "summary": "New parent is not in the same table.", "value": { - "message": "Cannot update constant with GUID '46661892-f207-45e4-8f3a-5ef81df98658'.", - "code": "constantUpdate", - "constantGuid": "46661892-f207-45e4-8f3a-5ef81df98658", + "message": "Cannot copy record history with GUID '0a0a07f6-20d8-4292-a275-a7385398d8a2'.", + "code": 400, "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Constant with GUID '0000000f-0004-4fff-8fff-0000ffff0000' already exists.", - "guid": "0000000f-0004-4fff-8fff-0000ffff0000", - "reason": "entityAlreadyExists", - "entityType": "constant" - } - ], - "reason": "namedEntity" + "message": "New parent record history (GUID = '5a842e54-e143-45f5-aec8-18fb84f4fe03') is not in the same table.", + "reason": "ParentNotInSameTable" } ] } }, - "Example 3": { - "summary": "Unit not found", - "description": "The specified unit GUID does not exist in the database.", + "Example 7": { + "summary": "The 'short name' of the record to be copied is not unique under the new parent.", "value": { - "message": "Cannot update constant with GUID '8537631a-b632-445a-9ba3-43c7fcdca43d'.", - "code": "constantUpdate", - "constantGuid": "8537631a-b632-445a-9ba3-43c7fcdca43d", + "message": "Cannot copy record history with GUID 'b39060d9-ac86-48dc-9e75-7ea241b7a556'.", + "code": 400, "errors": [ { - "message": "Could not find unit with GUID '0ffda962-040e-41e3-a60b-7520ee4a050c'.", - "guid": "0ffda962-040e-41e3-a60b-7520ee4a050c", - "reason": "noSuchUnit" + "message": "A record with the short name 'Sheet' already exists in the parent folder.", + "reason": "ShortNameExistsInFolder" } ] } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or constant not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Constants" - ], - "summary": "Delete a constant", - "operationId": "DeleteConstant", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which constant will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "constant-guid", - "in": "path", - "description": "Guid of constant to delete", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Constant in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaConstantDeletionException" - }, - "example": { - "message": "Cannot delete constant with GUID '00000001-0004-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "guid": "00000001-0004-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more expressions.", - "reason": "usage", - "referencedByType": "expression", - "referencedBy": [ + }, + "Example 8": { + "summary": "New parent is withdrawn.", + "value": { + "message": "Cannot copy record history with GUID 'ce294339-e59d-4be1-a96c-f9e92adb71ac'.", + "code": 400, + "errors": [ { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + "message": "New parent record history (GUID = '4afa8a76-cd32-4835-be9d-31756bb9b7fb') is withdrawn or has a withdrawn ancestor.", + "reason": "ParentIsWithdrawn" } ] } - ] - } - } - } - }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or constant not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/data-rules": { - "get": { - "tags": [ - "Schema - Data Rules" - ], - "summary": "Gets all data rules for a given database.", - "operationId": "GetDataRules", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataRulesInfo" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Data Rules" - ], - "summary": "Create a new data rule", - "operationId": "CreateDataRule", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" - }, - "examples": { - "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", - "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" - }, - "examples": { - "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", - "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" - }, - "examples": { - "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", - "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDataRule" - }, - "examples": { - "Example 1": { - "summary": "Data rule for attributes", - "description": "This example demonstrates how to create a new data rule.", - "value": { - "description": "Only numeric digits are allowed.", - "regularExpression": "^[0-9]*$", - "name": "digits only" } } } } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataRule" - } - } - } - }, - "400": { - "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/latest": { "get": { "tags": [ - "Schema - Data Rules" + "Records - Record Histories" ], - "summary": "Gets a data rule for a given database and guid.", - "operationId": "GetDataRule", + "summary": "Get the latest record version for a record history for a given database and table.", + "operationId": "GetLatestRecordVersionFromTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "data-rule-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataRule" - } - } - } - }, - "404": { - "description": "Database or data rule not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Data Rules" - ], - "summary": "Edit a data rule", - "operationId": "UpdateDataRule", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "data-rule-guid", + "name": "record-history-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDataRule" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataRule" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database or data rule name not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Data Rules" - ], - "summary": "Delete a data rule.", - "operationId": "DeleteDataRule", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "data-rule-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." }, - "404": { - "description": "Database or data rule not found." - } - } - } - }, - "/v1alpha/databases": { - "get": { - "tags": [ - "Schema - Databases" - ], - "summary": "Lists all databases that the user can see.", - "operationId": "GetAllDatabases", - "parameters": [ { - "name": "role", - "in": "query", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ "read", - "write", - "powerUser", - "grant", - "admin" + "write" ], "type": "string" } @@ -44602,396 +23167,217 @@ ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabasesInfo" + "$ref": "#/components/schemas/GsaRecordVersion" }, "example": { - "databases": [ - { - "key": "MI_Training", - "status": "Ok", - "isReadOnly": false, - "isLocked": false, - "name": "MI Training", - "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "indexInSync": true, - "schemaVersion": "2022.08.18.01" - } - ] - } - } - } - } - } - }, - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Adds a database to the MI server. Only available to users in the System Administrator role.", - "operationId": "AddDatabase", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" } } } }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." + "404": { + "description": "Database, table or record history not found" } } } }, - "/v1alpha/databases/{database-key}": { + "/v1alpha/databases/{database-key}/record-histories/{record-history-guid}/latest": { "get": { "tags": [ - "Schema - Databases" + "Records - Record Histories" ], - "summary": "Returns details for a given database.", - "operationId": "GetDatabase", + "summary": "Get the latest record version for a record history for a given database.", + "operationId": "GetLatestRecordVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabase" - } - } + "type": "string" } }, - "404": { - "description": "Database not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Databases" - ], - "summary": "Removes the database from the MI server. Only available to users in the System Administrator role.", - "operationId": "RemoveDatabase", - "parameters": [ { - "name": "database-key", + "name": "record-history-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "OK." - }, - "400": { - "description": "Bad request. Returned if database is in the \"Unloading\" state" - }, - "403": { - "description": "Forbidden." }, - "404": { - "description": "Database not found." - } - } - }, - "patch": { - "tags": [ - "Schema - Databases" - ], - "summary": "Update database details.", - "operationId": "UpdateDatabase", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "allow-reload", - "in": "query", - "description": "This must be set to true if any of the following properties are patched:\r\n DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid.\r\n The database will reload after the changes have been applied.", + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "boolean", - "default": false + "enum": [ + "read", + "write" + ], + "type": "string" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" - }, - "examples": { - "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "ddd59515-fed6-4a14-92f6-9911b199f81b", - "guid": "62a14237-f939-4a0b-8e71-760d66063cc4", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", - "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", - "value": { - "isImplicitProfileDisabled": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" - }, - "examples": { - "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "ddd59515-fed6-4a14-92f6-9911b199f81b", - "guid": "62a14237-f939-4a0b-8e71-760d66063cc4", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", - "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", - "value": { - "isImplicitProfileDisabled": true - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" - }, - "examples": { - "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "ddd59515-fed6-4a14-92f6-9911b199f81b", - "guid": "62a14237-f939-4a0b-8e71-760d66063cc4", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", - "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", - "value": { - "isImplicitProfileDisabled": true - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabase" - }, - "examples": { - "Example 1": { - "summary": "Update everything in a database", - "description": "This example shows how to update all properties of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)", - "company": "ANSYS, Inc. (updated)", - "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", - "currencyCode": "PLN", - "versionGuid": "ddd59515-fed6-4a14-92f6-9911b199f81b", - "guid": "62a14237-f939-4a0b-8e71-760d66063cc4", - "name": "MI Training (Updated)", - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Update the author": { - "summary": "This example shows how to update the 'Author' property of the MI_Training database.", - "value": { - "author": "Ansys Granta Technical Training (Updated)" - } - }, - "Update the default table": { - "summary": "This example shows how to update the 'default table' property of the MI_Training database to the Process Universe table.", - "value": { - "defaultTable": { - "guid": "00003248-0011-4fff-8fff-0000ffff0000" - } - } - }, - "Disable the implicit Profile": { - "summary": "This example shows how to disable the implicit Profile for this database.", - "value": { - "isImplicitProfileDisabled": true - } - } - } - } - } - }, "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" } } } }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, "404": { - "description": "Database not found." + "description": "Database or record history not found" } } } }, - "/v1alpha/databases/{database-key}/all-table-types": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}": { "get": { "tags": [ - "Schema - Databases" + "Records - Record Versions" ], - "summary": "Get Protection Status for a given database. The user must be an Admin user for the database.", - "operationId": "GetAllTableTypes", + "summary": "Get a record version with a specified guid for a given database, table and record history.", + "operationId": "GetRecordVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -45001,492 +23387,612 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTableTypesInfo" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "ba22491d-b470-42cf-80d7-531ff81b1583" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Alumino silicate - 1720", + "recordColor": "fuchsia", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": false, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 1, + "versionState": "unversioned", + "name": "Alumino silicate - 1720", + "guid": "00000026-000e-4fff-8fff-dd92ffff0000" } } } }, "404": { - "description": "Database key not found" + "description": "Database, table, record history or record version not found" } } - } - }, - "/v1alpha/databases/default": { - "get": { + }, + "delete": { "tags": [ - "Schema - Databases" + "Records - Record Versions" ], - "summary": "Returns details for a default database or null if the default database is not set or user cannot see it.", - "operationId": "GetDefaultDatabase", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabase" - } - } + "summary": "Deletes the record version. If the table is version controlled, only the current unreleased record version can be deleted.", + "operationId": "DeleteRecordVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "204": { - "description": "No default database set." - } - } - }, - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Sets the default database.", - "operationId": "UpdateDefaultDatabase", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultDatabase" - } + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } } - }, + ], "responses": { "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabase" - } - } - } + "description": "Ok" }, "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." + "description": "Bad request. Table is version controlled and record version is not unreleased." }, "404": { - "description": "Database not found." + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/databases/defaultDataSource": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:release": { + "post": { "tags": [ - "Schema - Databases" + "Records - Record Versions" ], - "summary": "Returns data source used by the configuration database.", - "operationId": "GetDefaultDataSource", - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDataSource" - } - } + "summary": "Releases the record version. Must be an unreleased record version.", + "operationId": "ReleaseRecordVersion", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "403": { - "description": "Forbidden." + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } - } - } - }, - "/v1alpha/databases/defaultAdditionalSqlParameters": { - "get": { - "tags": [ - "Schema - Databases" ], - "summary": "Returns additional SQL parameters used by the configuration database.", - "operationId": "GetDefaultAdditionalSqlParameters", "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAdditionalSqlParameters" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": false, + "canRelease": false, + "canGetModifiableVersion": true, + "canWithdraw": true, + "canDelete": false + }, + "versionNumber": 1, + "versionState": "released", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } } } }, - "403": { - "description": "Forbidden." - } - } - } - }, - "/v1alpha/databases:validate": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Validates whether a database can be added to MI server. Only available to users in the System Administrator role.", - "operationId": "ValidateDatabaseToAdd", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabase" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", + "400": { + "description": "Bad request. Record version state is not unreleased, or table is not version controlled, or parent is not released.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseValidationResult" + "$ref": "#/components/schemas/GsaReleaseRecordVersionControlException" + }, + "examples": { + "Example 1": { + "summary": "Invalid version state.", + "description": "Only unreleased record versions can be released.", + "value": { + "message": "Cannot release record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Released'.", + "reason": "invalidVersionState", + "versionState": "released" + } + ] + } + }, + "Example 2": { + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot release record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + }, + "Example 3": { + "summary": "Parent is not released.", + "value": { + "message": "Cannot release record version with GUID '115a7d2d-c27d-4a8a-bb7b-aa72876c9773'.", + "code": 400, + "errors": [ + { + "message": "Tree parent is not in a valid state to perform this operation.", + "reason": "invalidParentState" + } + ] + } + } } } } }, - "400": { - "description": "Bad request." - }, "403": { - "description": "Forbidden." + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/databases/{database-key}:upgrade": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:get-modifiable-version": { "post": { "tags": [ - "Schema - Databases" + "Records - Record Versions" ], - "summary": "Upgrade a database to the latest schema version. Only available to users in the System Administrator role.", - "operationId": "UpgradeDatabase", + "summary": "Gets the latest modifiable record version, or creates a new one if none exists. The record version must be the latest version, and must be either released or withdrawn.", + "operationId": "GetModifiableRecordVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { - "400": { - "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\" or \"Unknown\" state", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseException" + "$ref": "#/components/schemas/GsaRecordVersion" }, - "examples": { - "Example 1": { - "summary": "Insufficient permissions for 'MI_TRAINING' database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade 'MI_TRAINING' database to a new schema version by a user that does not have sufficient database permissions.", - "value": { - "message": "Failed to upgrade database 'MI_TRAINING' - the connecting user must be a db_owner on the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "insufficientPermissions" - } + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" }, - "Example 2": { - "summary": "Unable to connect to 'MI_TRAINING' database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade 'MI_TRAINING' database to a new schema version, but user was unable to connect to the database.", - "value": { - "message": "Failed to upgrade database 'Unable to connect to the 'MI_TRAINING' database using provided credentials.' - could not connect to the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "unableToConnect", - "additionalInformation": "MI_TRAINING" - } - } - } - } - } - }, - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": true, + "canRelease": true, + "canGetModifiableVersion": false, + "canWithdraw": false, + "canDelete": true + }, + "versionNumber": 2, + "versionState": "unreleased", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } } } }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." - } - } - } - }, - "/v1alpha/databases:upgrade-external": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Upgrades an external database to the latest schema version. Only available to users in the System Administrator role.", - "operationId": "UpgradeDatabaseNotAddedToMi", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" - } - } - } - }, - "responses": { "400": { - "description": "Bad request. Returned if connecting user is not a db_owner on the database.", + "description": "Bad request. Record version state is not the latest version, is not released or withdrawn, or table is not version controlled.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseException" + "$ref": "#/components/schemas/GsaGetModifiableRecordVersionControlException" }, "examples": { "Example 1": { - "summary": "Insufficient permissions for a database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade a database to a new schema version by a user that does not have sufficient database permissions.", + "summary": "Invalid version state.", + "description": "A new version can only be created from the latest released or withdrawn record version.", "value": { - "message": "Failed to upgrade database - the connecting user must be a db_owner on the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "insufficientPermissions" + "message": "Cannot create a new version from the record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Superseded'.", + "reason": "invalidVersionState", + "versionState": "superseded" + } + ] } }, "Example 2": { - "summary": "Unable to connect to a database", - "description": "This example demonstrates an error response returned for an invalid request that attempted to upgrade a database to a new schema version, but user was unable to connect to the database.", + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot create a new version from the record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + }, + "Example 3": { + "summary": "Record version is not the latest version.", "value": { - "message": "Failed to upgrade database - could not connect to the database.", - "code": "upgradeDatabase", - "upgradeDatabaseFailureReason": "unableToConnect", - "additionalInformation": "Unable to connect to the database using provided credentials." + "message": "Cannot create a new version from the record version with GUID '7947f8d7-2b7f-4cb8-9e45-6a83379341dd'.", + "code": 400, + "errors": [ + { + "message": "There is a newer version.", + "reason": "notTheLatestVersion", + "newerVersion": { + "versionNumber": 2, + "versionState": "unreleased", + "name": "Arsenic trioxide [1327-53-3] - new version", + "guid": "15b04769-33e0-4db2-8763-797bb34f059d" + } + } + ] } } } } } }, - "200": { - "description": "OK." - }, "403": { - "description": "Forbidden." + "description": "Forbidden" + }, + "404": { + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/databases/{database-key}:reload": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-histories/{record-history-guid}/record-versions/{record-version-guid}:withdraw": { "post": { "tags": [ - "Schema - Databases" + "Records - Record Versions" ], - "summary": "Reloads a database. Only available to users in the System Administrator role.", - "operationId": "ReloadDatabase", + "summary": "Withdraws the record version. Must be a released record version.", + "operationId": "WithdrawRecordVersion", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-history-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-version-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimDatabase" + "$ref": "#/components/schemas/GsaRecordVersion" + }, + "example": { + "recordHistory": { + "guid": "0a0a07f6-20d8-4292-a275-a7385398d8a2" + }, + "table": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "databaseKey": "MI_TRAINING", + "createdByUser": "A User", + "createdDate": "2018-01-01T00:00:00+00:00", + "lastModifiedByUser": "A User", + "lastModifiedDate": "2018-01-02T00:00:00+00:00", + "recordType": "record", + "shortName": "Arsenic trioxide [1327-53-3]", + "recordColor": "red", + "capabilities": { + "canWrite": true, + "canModify": false, + "canRelease": false, + "canGetModifiableVersion": true, + "canWithdraw": false, + "canDelete": false + }, + "versionNumber": 1, + "versionState": "withdrawn", + "name": "Arsenic trioxide [1327-53-3]", + "guid": "e1a72a7e-155e-47f9-b6c9-285fd5d3288a" } } } }, "400": { - "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\", \"SchemaUpgradeRequired\" or \"SchemaDowngradeRequired\" state" - }, - "403": { - "description": "Forbidden." + "description": "Bad request. Record version state is not released, or table is not version controlled.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaWithdrawRecordVersionControlException" + }, + "examples": { + "Example 1": { + "summary": "Invalid version state.", + "description": "Only released record versions can be withdrawn.", + "value": { + "message": "Cannot withdraw record version with GUID 'e1a72a7e-155e-47f9-b6c9-285fd5d3288a'.", + "code": 400, + "errors": [ + { + "message": "Invalid version state 'Unreleased'.", + "reason": "invalidVersionState", + "versionState": "unreleased" + } + ] + } + }, + "Example 2": { + "summary": "Table is not version controlled.", + "value": { + "message": "Cannot withdraw record version with GUID '00000026-000e-4fff-8fff-dd92ffff0000'.", + "code": 400, + "errors": [ + { + "message": "Table is not version controlled.", + "reason": "notVersioned" + } + ] + } + } + } + } + } }, "404": { - "description": "Database not found." + "description": "Database, table, record history or record version not found" } } } }, - "/v1alpha/databases/{database-key}:lock": { - "post": { + "/v1alpha/schema/mi-version": { + "get": { "tags": [ - "Schema - Databases" - ], - "summary": "Lock database", - "operationId": "LockDatabase", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database to lock", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } + "Schema" ], + "summary": "Returns the currently running MI version to the caller.", + "operationId": "GetVersion", "responses": { "200": { - "description": "OK.", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "$ref": "#/components/schemas/GsaMiVersion" } } } - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." } } } }, - "/v1alpha/databases/{database-key}:unlock": { - "post": { + "/v1alpha/security-attribute-groupings": { + "get": { "tags": [ - "Schema - Databases" - ], - "summary": "Unlock database", - "operationId": "UnlockDatabase", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database to unlock", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } + "Schema" ], + "summary": "Gets all security attribute groupings for a given database.", + "operationId": "GetSecurityAttributeGroupings", "responses": { "200": { - "description": "OK.", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabase" + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSecurityAttributeGrouping" + } + } } } } - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found." } } } }, - "/v1alpha/databases/{database-key}:outbound-links": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes": { + "get": { "tags": [ - "Schema - Databases" + "Schema - Attributes" ], - "summary": "Get all link groups and tabular attributes pointing from the database, i.e. the source of the link is in the given database.\r\nMay include links where the target is in the same database, or where the target cannot be resolved (e.g. the target database is not loaded).", - "operationId": "GetOutboundLinks", + "summary": "Get all attributes in table", + "operationId": "GetAttributes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "type", - "in": "query", - "description": "The link types to include in the response. If not provided, all link types are included.", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - } + "type": "string", + "format": "uuid" } }, { @@ -45520,1671 +24026,1639 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLinksInfo" + "$ref": "#/components/schemas/GsaAttributesInfo" + } + } + } + }, + "404": { + "description": "Database, table or attribute not found" + } + } + }, + "post": { + "tags": [ + "Schema - Attributes" + ], + "summary": "Create a new attribute.", + "operationId": "CreateAttribute", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" + } }, - "example": { - "links": [ - { - "type": "recordLink", - "includeIndirectLinks": false, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "Example 2": { + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "0827e0df-5760-424e-94fc-b4da111f2ef7" + } + }, + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" + } + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" + } + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" + } + }, + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" + } + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" + } + }, + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" } - }, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" + } + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" }, - { - "type": "smartLink", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" } - ], - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" + } + }, + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" }, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" }, - "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - }, - { - "type": "crossDatabaseLink", - "includeIndirectLinks": false, - "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } }, - "linkTarget": { - "databaseGuid": "ed23ed42-345a-4475-b78e-60f54f01ee4d", - "tableGuid": "aff6fb03-371a-4e84-a190-a2f9b4d8dccf" + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } - }, - "displayNames": {}, - "name": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "guid": "7d63b0b0-1578-4378-88d7-5b4a630158b7" + ] }, - { - "type": "tabularAttribute", - "targetAttribute": { - "guid": "00000099-0001-4fff-8fff-dd92ffff0000" + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" + } + }, + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" }, - "reverseName": "Environmental performances overview", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" }, - "displayNames": {}, - "name": "Environmental performances overview", - "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" - } - ] + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" + } } } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases:check-retarget-potential": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Check databases for retarget potential - whether there are any cross-database tabular attributes targeting them.", - "operationId": "CheckDatabasesForRetargetPotential", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" - } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetPotentialRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabasesInfo" + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" + } }, - "example": { - "databases": [ - { - "key": "MI_Training", - "status": "Ok", - "isReadOnly": false, - "isLocked": false, - "name": "MI Training", - "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "indexInSync": true, - "schemaVersion": "2022.08.18.01" - } - ] - } - } - } - }, - "400": { - "description": "Bad request." - } - } - } - }, - "/v1alpha/databases:retarget": { - "post": { - "tags": [ - "Schema - Databases" - ], - "summary": "Retargets tabulars from the current database to a new one.", - "operationId": "RetargetTabulars", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRetargetResultsInfo" - } - } - } - }, - "400": { - "description": "Bad request." - }, - "404": { - "description": "Database not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/permission-category-access-controls": { - "get": { - "tags": [ - "Schema - Databases" - ], - "summary": "Get permission-based access control settings for the database.\r\nReturns the access control for each permission in each category.", - "operationId": "GetDatabasePermissionCategoryAccessControls", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "Example 2": { + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "0827e0df-5760-424e-94fc-b4da111f2ef7" + } }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] + "Example 3": { + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", + "value": { + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" + } + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" + } + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" + } + }, + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" + } + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - }, - "patch": { - "tags": [ - "Schema - Databases" - ], - "summary": "Update permission-based access control settings for the database.\r\nSets the access control for the given permissions.", - "operationId": "UpdateDatabasePermissionCategoryAccessControls", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", "value": { - "categoryAccessControls": [ + "type": "point", + "isMultiValued": true, + "attributeParameters": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "guid": "00000001-000a-4fff-8fff-0000ffff0000" } - ] + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } } - ] + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 5": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "categoryAccessControls": [ + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } } - ] + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" } }, - "Example 6": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "categoryAccessControls": [ + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] + "guid": "00000007-000a-4fff-8fff-0000ffff0000" }, { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" - }, - "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" }, - "permissionAccessControls": [ + "parameterContents": [ { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 }, - "canRead": true, - "canWrite": false + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } }, { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 }, - "canRead": true, - "canWrite": true + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } }, { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 9": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '011d77ad-0bad-45a9-aa95-82371b4d58f0', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID '011d77ad-0bad-45a9-aa95-82371b4d58f0' does not exist.", - "categoryGuid": "011d77ad-0bad-45a9-aa95-82371b4d58f0", - "reason": "noSuchCategory" - } - ] - } - }, - "Example 10": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID 'deac8972-6a04-4a32-ac01-e6ba8b397efd' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID 'deac8972-6a04-4a32-ac01-e6ba8b397efd' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "permissionGuid": "deac8972-6a04-4a32-ac01-e6ba8b397efd", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "reason": "noSuchPermission" - } - ] - } - }, - "Example 11": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ], - "reason": "duplicateCategoryGuids" - } - ] - } - }, - "Example 12": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ], - "reason": "duplicatePermissionGuids" + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - }, - "422": { - "description": "MI not in permission-based access control mode" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets all discrete types for a given database.", - "operationId": "GetDiscreteTypes", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypesInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Create a new discrete type.", - "operationId": "CreateDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", - "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" - } - }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", - "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" } }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ { - "name": "Value A" + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" }, { - "name": "Value B" + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" }, { - "name": "Value C" + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" } ], - "name": "Discrete Type Name" + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" } }, "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "0827e0df-5760-424e-94fc-b4da111f2ef7" } }, "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "isOrdered": false, - "discreteValues": [ - { - "name": "Value A" - }, - { - "name": "Value B" - }, - { - "name": "Value C" - } - ], - "name": "Discrete Type Name" + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", + }, + "Example 4": { + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" } }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" } }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ - { - "name": "Value A" - }, - { - "name": "Value B" - }, + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" + } + }, + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Mass" + } + }, + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Observed masses" + } + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ { - "name": "Value C" + "guid": "00000001-000a-4fff-8fff-0000ffff0000" } ], - "name": "Discrete Type Name" + "defaultThresholdType": "atLeast", + "name": "Max ratio" } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateDiscreteType" - }, - "examples": { - "Example 1": { - "summary": "Ordered Discrete Type", - "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", "value": { - "isOrdered": true, - "name": "Ordered Discrete Type" + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" } }, - "Example 2": { - "summary": "Unordered Discrete Type", - "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", "value": { - "isOrdered": false, - "name": "Unordered Discrete Type" + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" } }, - "Example 3": { - "summary": "Discrete Type with Discrete Values", - "description": "This example demonstrates how to create a new discrete type with discrete values for the MI_Training database.", + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isOrdered": false, - "discreteValues": [ - { - "name": "Value A" - }, + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" + } + }, + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", + "value": { + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" + } + }, + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ { - "name": "Value B" - }, + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" + } + }, + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ { - "name": "Value C" + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } } ], - "name": "Discrete Type Name" + "defaultThresholdType": "equal", + "name": "Environmental resistance" } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteType" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets a single discrete type.", - "operationId": "GetDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteType" - } - } - } - }, - "404": { - "description": "Database or discrete type not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Update discrete type.", - "operationId": "UpdateDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDiscreteType" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimDiscreteType" - } - } - } - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or discrete type not found." - } - } - }, - "delete": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Delete discrete type, including all of its discrete values.", - "operationId": "DeleteDiscreteType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Discrete type in use by Attributes.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeDeletionException" }, - "example": { - "message": "Cannot delete discrete type with GUID '00000083-0006-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "guid": "00000083-0006-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, { "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" }, - "name": "Metals", - "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] - } - ] - } - } - } - }, - "200": { - "description": "OK." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or discrete type not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}:usages": { - "get": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets objects that are using this discrete type.", - "operationId": "GetAttributesForType", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "response-filters", - "in": "query", - "description": "The discrete type usage types to include in the response. If none are provided, all types are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteTypeUsageType" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteTypeUsage" + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" + } }, - "example": { - "attributes": [ - { - "type": "discrete", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", + "value": { + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" }, - "name": "Reinforcement architecture", - "guid": "b172b9b3-228c-4784-9eaa-66349442f930" - } - ], - "tabularColumns": [ - { - "tabularAttribute": { - "type": "link", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" }, - "name": "Lay-up sequence details", - "guid": "af6fc0e6-dfbb-4f51-aad3-79419cd5ee92" + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" }, - "columns": [ - { - "name": "Ply/layer architecture", - "guid": "d0f981f1-9934-4518-af7e-f2a67573f0b0" - } - ] - } - ] + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "defaultThresholdType": "exists", + "name": "Restricted Substances" + } } } - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Database or discrete type not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types:query": { - "post": { - "tags": [ - "Schema - Discrete Types" - ], - "summary": "Gets discrete types for a given database, populates the requested properties.", - "operationId": "QueryDiscreteTypes", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { + }, + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" + "$ref": "#/components/schemas/GsaCreateAttribute" }, "examples": { "Example 1": { - "summary": "Fetch all discrete types with custom properties", + "summary": "Date-time attribute", + "description": "This example demonstrates how to create a new date-time attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date" } }, "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "summary": "Date-time attribute with guid", + "description": "This example demonstrates how to create a new date-time attribute with a specified guid for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "type": "dateTime", + "defaultThresholdType": "atMost", + "name": "Delivery date (guid)", + "guid": "0827e0df-5760-424e-94fc-b4da111f2ef7" } }, "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "summary": "Date-time attribute with IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to create a new date-time attribute that should not be shown in search UIs. It will still be included in text searches. It will be created in the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The same thing can be done for all attribute types.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "type": "dateTime", + "defaultThresholdType": "exists", + "isHiddenFromSearchCriteria": true, + "name": "Delivery date (hidden from search criteria)" } }, "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "summary": "Discrete attribute - simple", + "description": "This example demonstrates how to create a new discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "isMultiValued": false, + "defaultThresholdType": "isOneOf", + "name": "Used material type" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all discrete types with custom properties", + }, + "Example 5": { + "summary": "Discrete attribute - multi-valued", + "description": "This example demonstrates how to create a multi-valued discrete attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000), using the 'Material type' discrete type, from the MI_Training database. You can change the attribute back to a single-valued one as long as there is no multi-valued data already existing.", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "type": "discrete", + "discreteType": { + "guid": "2ba638a6-b807-4480-a388-f1b5637489b2" + }, + "isMultiValued": true, + "defaultThresholdType": "isOneOf", + "name": "Appropriate material types" } }, - "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "Example 6": { + "summary": "File attribute", + "description": "This example demonstrates how to create a new file attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "type": "file", + "defaultThresholdType": "exists", + "name": "Details PDF" } }, - "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "Example 7": { + "summary": "Hyperlink attribute", + "description": "This example demonstrates how to create a new hyperlink attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true + "type": "hyperlink", + "defaultThresholdType": "exists", + "name": "Supplier website" + } + }, + "Example 8": { + "summary": "Integer attribute", + "description": "This example demonstrates how to create a new integer attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": false, + "defaultThresholdType": "atLeast", + "name": "Number of batches" + } + }, + "Example 9": { + "summary": "Integer attribute - unique", + "description": "This example demonstrates how to create a new integer attribute which is constrained to have unique values for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "integer", + "isUnique": true, + "defaultThresholdType": "atLeast", + "name": "Batch ID Number" + } + }, + "Example 10": { + "summary": "Logical attribute", + "description": "This example demonstrates how to create a new logical attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "logical", + "defaultThresholdType": "equal", + "name": "Inspected" + } + }, + "Example 11": { + "summary": "Long text attribute", + "description": "This example demonstrates how to create a new long text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "longText", + "defaultThresholdType": "exists", + "name": "Long Description" + } + }, + "Example 12": { + "summary": "Picture attribute", + "description": "This example demonstrates how to create a new picture attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "picture", + "defaultThresholdType": "exists", + "name": "Photo" + } + }, + "Example 13": { + "summary": "Point attribute - simple unitless", + "description": "This example demonstrates how to create a new point attribute to represent a unitless single-valued property for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "name": "My Shape factor" + } + }, + "Example 14": { + "summary": "Point attribute - simple with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a single-valued property with the unit of 'kg' from the MI_Training database.", + "value": { + "type": "point", + "isMultiValued": false, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "defaultThresholdType": "atLeast", + "name": "Mass" } }, - "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "Example 15": { + "summary": "Point attribute - multi-valued with unit", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a multi-valued property with the unit of 'kg' from the MI_Training database. You can later change the attribute back to single-valued as long as there is no multi-valued data already existing.", "value": { - "properties": { - "name": true, - "guid": true + "type": "point", + "isMultiValued": true, + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "defaultThresholdType": "atLeast", + "name": "Observed masses" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all discrete types with custom properties", + }, + "Example 16": { + "summary": "Point attribute - multi-valued with parameters", + "description": "This example demonstrates how to create a new point attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a parameterized multi-valued property. In this case, a unitless property with 'Temperature' parameter from the the MI_Training database", "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "defaultThresholdType": "atLeast", + "name": "Max ratio" + } + }, + "Example 17": { + "summary": "Range attribute - unitless", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = {MiTraining.MaterialUniverseTableGuid}) from the MI_Training database to represent a unitless range value.", + "value": { + "type": "range", + "defaultThresholdType": "atLeast", + "name": "Average permeability" + } + }, + "Example 18": { + "summary": "Range attribute - with unit", + "description": "This example demonstrates how to create a new range attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) to represent a range value with the unit 'K' from the MI_Training database.", + "value": { + "type": "range", + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "name": "Boiling point" } }, - "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "Example 19": { + "summary": "Short text attribute", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Label" } }, - "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "Example 20": { + "summary": "Short text attribute - unique", + "description": "This example demonstrates how to create a new short text attribute for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database which is constrained to be unique.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "Surface Finish" - ] - } + "type": "shortText", + "isUnique": true, + "defaultThresholdType": "exists", + "name": "Serial number" } }, - "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "Example 21": { + "summary": "Float functional attribute", + "description": "This example demonstrates how to create a new float functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true + "type": "floatFunctional", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all discrete types with custom properties", - "value": { - "properties": { - "isProtected": true, - "discreteValues": { - "name": true, - "guid": true - }, - "isOrdered": true, - "name": true, - "guid": true - } + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameter": { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + } + ], + "isRange": true, + "defaultThresholdType": "atLeast", + "name": "Electrical resistance with temperature" } }, - "Example 2": { - "summary": "Fetch all discrete types with name and discrete value names", + "Example 22": { + "summary": "Discrete functional attribute", + "description": "This example demonstrates how to create a new discrete functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "properties": { - "discreteValues": { - "name": true - }, - "name": true - } + "type": "discreteFunctional", + "discreteType": { + "guid": "0000000c-0006-4fff-8fff-0000ffff0000" + }, + "attributeParameters": [ + { + "type": "discrete", + "parameter": { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + } + ], + "defaultThresholdType": "equal", + "name": "Environmental resistance" } }, - "Example 3": { - "summary": "Fetch discrete type with name \"Surface Finish\"", + "Example 23": { + "summary": "Maths functional attribute", + "description": "This example demonstrates how to create a new maths functional attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true + "type": "mathsFunctional", + "unit": { + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "filter": { - "name": [ - "Surface Finish" + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "expressions": [ + { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + ], + "allowExtrapolation": false, + "isRange": false, + "defaultContent": { + "curveLabel": "Curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "expression": { + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + }, + "freeParameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 25000000.0, + "parameterRange": { + "lowValue": 20000000.0, + "highValue": 30000000.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "value": -0.25, + "parameterRange": { + "lowValue": -0.5, + "highValue": 0.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterValue": { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } ] - } + }, + "allowAllCompatibleExpressions": false, + "allowAnonymousExpressions": false, + "defaultThresholdType": "equal", + "name": "Fatigue strength model" } }, - "Example 4": { - "summary": "Fetch discrete types with matching GUID", - "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "Example 24": { + "summary": "Tabular attribute", + "description": "This example demonstrates how to create a new tabular attribute for the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true + "type": "link", + "displayFullTable": false, + "displaySummaryRowInline": true, + "hideUnlinkedRows": true, + "tabularColumns": [ + { + "columnType": "localLogical", + "defaultThresholdType": "contains", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Comments" + }, + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "name": "Substance" + }, + { + "columnType": "linkedColumn", + "linkedColumn": { + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "showAsLink": true, + "summaryRowEnabled": true, + "rollUpType": "min", + "summaryRowRollUpType": "list", + "name": "Rating" + } + ], + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" }, - "filter": { - "guid": [ - "2ba638a6-b807-4480-a388-f1b5637489b2", - "00000083-0006-4fff-8fff-0000ffff0000" - ] - } + "defaultThresholdType": "exists", + "name": "Restricted Substances" } } } @@ -47192,505 +25666,681 @@ } }, "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryDiscreteTypesInfo" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values": { - "get": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Gets all discrete values for a given discreteType, returned in order.", - "operationId": "GetDiscreteValues", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" - } - } - } - }, - "404": { - "description": "Database or discrete type not found" - } - } - }, - "post": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Create new discrete value. It will be added at the end.", - "operationId": "CreateDiscreteValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "examples": { - "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", - "value": { - "name": "New Discrete Value 1" - } - }, - "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", - "value": { - "name": "New Discrete Value 2", - "guid": "da5dc223-f02f-4183-aa2e-683eb1aede33" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "examples": { - "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", - "value": { - "name": "New Discrete Value 1" - } - }, - "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", - "value": { - "name": "New Discrete Value 2", - "guid": "da5dc223-f02f-4183-aa2e-683eb1aede33" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "examples": { - "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", - "value": { - "name": "New Discrete Value 1" - } - }, - "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", - "value": { - "name": "New Discrete Value 2", - "guid": "da5dc223-f02f-4183-aa2e-683eb1aede33" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "examples": { - "Example 1": { - "summary": "Discrete Value", - "description": "This example demonstrates how to create a new discrete value.", - "value": { - "name": "New Discrete Value 1" - } + "$ref": "#/components/schemas/GsaAttribute" }, - "Example 2": { - "summary": "Discrete Value with Guid", - "description": "This example demonstrates how to create a new discrete value with a specified guid value.", - "value": { - "name": "New Discrete Value 2", - "guid": "da5dc223-f02f-4183-aa2e-683eb1aede33" + "examples": { + "Example 5": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "value": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + "Example 6": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "3b3d5696-1377-4dc5-9989-bfd16f117567" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 8": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + } + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } } } } } - } - }, - "responses": { - "201": { - "description": "Created", + }, + "400": { + "description": "Bad request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "$ref": "#/components/schemas/GsaAttributeCreationException" + }, + "examples": { + "Example 1": { + "summary": "No such discrete type", + "description": "The GUID provided for the discrete type does not match a discrete type in the database.", + "value": { + "message": "Cannot create attribute 'Used material type'.", + "code": 400, + "errors": [ + { + "message": "Could not find discrete type with GUID 'f4bb8e7a-2cd9-4ed9-999d-ba76f79ac6d5' in database 'MI_Training'.", + "guid": "f4bb8e7a-2cd9-4ed9-999d-ba76f79ac6d5", + "databaseKey": "MI_Training", + "entityType": "discreteType", + "reason": "noSuchEntity" + } + ] + } + }, + "Example 2": { + "summary": "Multiple validation errors for creating a MathsFunctional Attribute", + "description": "Unit not found; no expressions specified (and 'allow anonymous expressions' not set to true); parameterContents contains a parameter that is not in attributeParameters", + "value": { + "message": "Cannot create attribute 'Fatigue strength model'.", + "code": 400, + "errors": [ + { + "message": "Could not find unit with GUID 'cc8a4c62-e903-45df-8b79-e642cc2c3161' in database 'MI_Training'.", + "guid": "cc8a4c62-e903-45df-8b79-e642cc2c3161", + "databaseKey": "MI_Training", + "entityType": "unit", + "reason": "noSuchEntity" + }, + { + "message": "The Maths Functional attribute is not valid.", + "errors": [ + { + "message": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.", + "reason": "noExpressions" + }, + { + "message": "Parameters in parameter contents must be from this attribute's parameters. GUIDs not found in attribute's parameters: '24efb1da-618d-4769-9320-e65f23f105a6'.", + "parameterGuids": [ + "24efb1da-618d-4769-9320-e65f23f105a6" + ], + "reason": "parameterContentUnknownParameters" + } + ], + "reason": "mathsFunctional" + } + ] + } + }, + "Example 3": { + "summary": "Invalid JSON", + "description": "The required property 'name' was not provided.", + "value": { + "message": "CreateDateTimeAttribute: Required property 'name' not found in JSON", + "code": 400 + } + } } } } }, - "400": { - "description": "Bad Request" - }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or discrete type not found" + "description": "Database or table not found" } } - }, - "put": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}": { + "get": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Attributes" ], - "summary": "Replace the whole discrete value collection for a given discrete type.\r\nThis will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails.\r\nIf any discrete values are included in the request that have a guid that matches an existing discrete value then the existing discrete value will be modified.\r\nIf any discrete values are included in the request body where the name matches an existing discrete value but no guid is provided, or the guid does not match, the operation will fail.", - "operationId": "ReplaceDiscreteValues", + "summary": "Get attribute in table", + "operationId": "GetAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "discrete-type-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" - } - } - } - }, - "400": { - "description": "Bad Request. e.g. would delete a discrete value that is in use." - }, - "403": { - "description": "Forbidden" }, - "404": { - "description": "Database or discrete type not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": { - "get": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Gets specific discrete value for a given discreteType within a given database.", - "operationId": "GetDiscreteValue", - "parameters": [ { - "name": "database-key", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "discrete-type-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "discrete-value-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" + "$ref": "#/components/schemas/GsaAttribute" + }, + "examples": { + "Example 1": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "value": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + "Example 2": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 3": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "e02dada4-764b-4f7f-8db0-2dabf218e994" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 4": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + } + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + } } } } }, "404": { - "description": "Database, discrete type or discrete value not found" + "description": "Database, table or attribute not found" } } }, "patch": { "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Update discrete value.", - "operationId": "UpdateDiscreteValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "discrete-value-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" - } - } - } - }, - "responses": { - "200": { - "description": "OK.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" - } - } - } - }, - "400": { - "description": "Bad request." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, discrete type or discrete value not found." - } - } - }, - "delete": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" + "Schema - Attributes" ], - "summary": "Delete a single discrete value. It must not be used by any data, or the operation will fail.", - "operationId": "DeleteDiscreteValue", + "summary": "Update attribute.", + "operationId": "UpdateAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "discrete-type-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "discrete-value-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad request. Discrete value in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValueAggregateException" - } - } - } - }, - "200": { - "description": "OK." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, discrete type or discrete value not found." - } - } - } - }, - "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values:find-unused": { - "get": { - "tags": [ - "Schema - DiscreteTypes - DiscreteValues" - ], - "summary": "Find discrete values that are not in use by any data", - "operationId": "FindUnusedDiscreteValues", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "discrete-type-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -47699,1084 +26349,1076 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" - } - } - } - }, - "400": { - "description": "Bad Request" - }, - "404": { - "description": "Database or discrete type not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/display-names/{language}": { - "get": { - "tags": [ - "Schema - Display Names" - ], - "summary": "Gets display names for all localized entities in the database, in the given language.", - "operationId": "GetAllDisplayNames", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "language", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDisplayNamesInfo" - }, - "example": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - null, - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "FPS (Consistent)", - null, - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "French display name for Value", - "fr", - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/display-names": { - "patch": { - "tags": [ - "Schema - Display Names" - ], - "summary": "Updates display names for localized entities in the database.\r\nReturns the number of entities updated.", - "operationId": "ImportDisplayNames", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] + "type": "discrete", + "name": "Metals (updated)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" + } + }, + "Example 4": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "defaultThresholdType": "equal" + } + }, + "Example 5": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "isHiddenFromSearchCriteria": true + } + }, + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "isMultiValued": true + } + }, + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true + } + }, + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true + } + }, + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] + } + }, + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "value": { + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + } + } + }, + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" + } + }, + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + }, + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } ] } } + }, + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + }, + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + } + } + }, + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": null + } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] - } + "type": "discrete", + "name": "Metals (updated)" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" - }, - "examples": { - "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" + } + }, + "Example 4": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "defaultThresholdType": "equal" + } + }, + "Example 5": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "isHiddenFromSearchCriteria": true + } + }, + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "discrete", + "isMultiValued": true + } + }, + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true + } + }, + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true + } + }, + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] + } + }, + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "value": { + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" } } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNames" - }, - "examples": { - "Example 1": { - "summary": "Update display names", - "description": "This example demonstrates how to update the display names for Unit System 'CGS (Consistent)', Attribute 'Young's modulus' in table 'MaterialUniverse' and Attribute Axis Name 'Value' on Meta-Attribute 'Incompressibility Parameter D1' on Attribute 'Mooney-Rivlin' in Table 'Design Data' in the MI_Training database.", + }, + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "displayNames": { - "headers": [ - "Schema Object Name", - "Display Name", - "Display Name Language", - "Do Not Edit -->", - "Type", - "Extra 1", - "Extra 2", - "Extra 3" - ], - "rows": [ - [ - "CGS (Consistent)", - "New French display name for CGS (Consistent)", - "fr", - null, - "UnitSystem", - null, - null, - null - ], - [ - "Young's modulus", - "French display name for Young's modulus", - "fr", - null, - "Attribute", - "MaterialUniverse", - null, - null - ], - [ - "Value", - "New French display name for Value", - "fr", - null, - "AttributeAxisName", - "Design Data", - "Incompressibility Parameter D1", - "Mooney-Rivlin" - ] - ] + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" + } + }, + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" } } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateDisplayNamesResponse" - } - } - } - }, - "400": { - "description": "Bad Request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDisplayNamesImportException" }, - "examples": { - "Example 1": { - "summary": "Schema item not found", - "description": "A unit system could not be found with the provided name.", - "value": { - "message": "Cannot import display names.", - "code": "displayNamesImport", - "errors": [ + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + }, + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, { - "message": "'UnitSystemName' in column 'Schema Object Name' was not found in the database.", - "reason": "schemaItemNotFound", - "rowIndex": 2, - "fieldValue": "CGSx", - "columnHeader": "Schema Object Name", - "itemType": "UnitSystemName" + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'headers' was not provided.", - "value": { - "message": "Grid: Required property 'headers' not found in JSON", - "code": "jsonSerialization" - } } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get All Exporter Folders", - "operationId": "GetExportersFolders", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + } }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - }, - { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "MI_Training", - "guid": "19cc65a2-f8bf-4989-9859-e883756290de" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - } - } - }, - "404": { - "description": "Database not found" - } - } - }, - "post": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Create a new Exporters Folder.", - "operationId": "CreateExportersFolder", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" - }, - "examples": { - "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "link", + "target": null } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "name": "Metals (updated)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" + } + }, + "Example 4": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "defaultThresholdType": "equal" + } + }, + "Example 5": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "isHiddenFromSearchCriteria": true + } + }, + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "discrete", + "isMultiValued": true } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" - }, - "examples": { - "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + }, + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "shortText", + "isUnique": true } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" - }, - "examples": { - "Example 1": { - "summary": "Exporter Folder", - "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", + }, + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "name": "New Folder" + "type": "point", + "isMultiValued": true } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", + "value": { + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] + } }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", + "value": { + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + } + } }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", + "value": { + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" + } }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "name": "Abaqus", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "folder" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" } } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "name": "Abaqus", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "folder" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" }, - "examples": { - "Example 1": { - "summary": "Folder with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter folder with name 'Abaqus' in the 'MI_Training' folder (GUID '19cc65a2-f8bf-4989-9859-e883756290de'), but there is already a folder with that name and parent.", - "value": { - "message": "Cannot create Exporter folder 'Abaqus'.", - "code": "folderCreation", - "name": "Abaqus", - "folderType": "exporter", - "errors": [ + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Folder with name 'Abaqus' already exists in this Folder.", - "name": "Abaqus", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "folder" - } - ], - "reason": "namedEntity" + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } } ] } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters:root-folder": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Root Exporters Folder", - "operationId": "GetExportersRootFolder", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Exporters Folder", - "operationId": "GetExportersFolder", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" }, - "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } }, - "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + } + } }, - "example": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": null + } } } - } - }, - "404": { - "description": "Database or folder not found" - } - } - }, - "patch": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Update an existing Exporters Folder.", - "operationId": "UpdateExportersFolder", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { + }, + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "name": "Metals (updated)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Melting point' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000d-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "guid": "12345678-0013-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update help path", + "description": "This example demonstrates how to update the 'HelpPath' property of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "helpPath": "html/attributenotes/metals.html" + } + }, + "Example 4": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", + "value": { + "type": "discrete", + "defaultThresholdType": "equal" + } + }, + "Example 5": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000).", "value": { - "name": "New Folder Name" + "type": "discrete", + "isHiddenFromSearchCriteria": true } }, - "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "Example 6": { + "summary": "Make discrete multi-valued", + "description": "This example demonstrates how to update the 'Metals' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 0000000b-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. You can similarly turn a multi-valued discrete attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "guid": "a8c0936e-ef54-40f0-9936-993acc3f77eb" + "type": "discrete", + "isMultiValued": true } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + }, + "Example 7": { + "summary": "Make short text unique", + "description": "This example demonstrates how to update the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and make it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "name": "New Folder Name" + "type": "shortText", + "isUnique": true } }, - "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "Example 8": { + "summary": "Make point multi-valued", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "guid": "a8c0936e-ef54-40f0-9936-993acc3f77eb" + "type": "point", + "isMultiValued": true } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + }, + "Example 9": { + "summary": "Make point multi-valued with parameter", + "description": "This example demonstrates how to update the 'Shape factor' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000144-0001-4fff-8fff-dd92ffff0000) and make it multi-valued with 'Temperature' as a parameter. Note that this won't work if the attribute is used in a dynamic link group index, expressions, X-Y charts or as linked attribute tabular column.You can similarly turn a multi-valued point attribute into a single-valued as long as there is no multi-valued data already existing.", "value": { - "name": "New Folder Name" + "type": "point", + "isMultiValued": true, + "attributeParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ] } }, - "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "Example 10": { + "summary": "Update unit", + "description": "This example demonstrates how to update the unit of the 'Reserves' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000088-0001-4fff-8fff-dd92ffff0000). We will change the unit from 'tonnes' to 'kg'", "value": { - "guid": "a8c0936e-ef54-40f0-9936-993acc3f77eb" + "type": "range", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + } } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Exporter Folder", - "description": "This example demonstrates how to rename an existing Exporter folder.", + }, + "Example 11": { + "summary": "Update multiple properties", + "description": "This example demonstrates that it is possible to change multiple attribute properties at once by updating the name of the 'Grain size' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 000000aa-0001-4fff-8fff-dd92ffff0000) and also making it unique. This will work as long as there is no pre-existing data which violates the constraint.", "value": { - "name": "New Folder Name" + "type": "shortText", + "isUnique": true, + "name": "Grain size (updated)" } }, - "Example 2": { - "summary": "Change guid for Exporter Folder", - "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", + "Example 12": { + "summary": "Turn an attribute into a meta-attribute", + "description": "This example demonstrates how to turn an existing attribute into a meta-attribute of another attribute. We make the short text 'Color' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; attributeGuid = 00000169-0001-4fff-8fff-dd92ffff0000) become a meta-attribute of 'ISO name' short text attribute (guid = 000002cf-0001-4fff-8fff-dd92ffff0000).Note that if an attribute already had meta-attribute, it cannot be made a meta-attribute. Also, you cannot add a meta-attribute to another meta-attribute.", + "value": { + "type": "shortText", + "aboutAttribute": { + "guid": "000002cf-0001-4fff-8fff-dd92ffff0000" + } + } + }, + "Example 13": { + "summary": "Add multiple parameters", + "description": "This example demonstrates how to update the 'Tensile strength with temperature' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '00000002-0001-4fff-8fff-dd92ffff0000') and add multiple parameters to it.", + "value": { + "type": "floatFunctional", + "attributeParameters": [ + { + "type": "numeric", + "defaultValue": 5.0, + "interpolationMethod": "auto", + "scaleType": "notSet", + "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "interpolationMethod": "linear", + "scaleType": "logarithmic", + "parameterGuid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "defaultValue": { + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + }, + "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + }, + "Example 14": { + "summary": "Add additional parameter and set default content for Maths Functional Attribute", + "description": "This example demonstrates how to update the 'Fatigue strength model (stress range)' attribute from the 'MaterialUniverse' table from the MI_Training database (tableGuid = '0000dd92-0011-4fff-8fff-0000ffff0000'; attributeGuid = '745db76c-a991-41b6-9fd6-2e5f544f8ecb') by adding additional parameter to it and setting its default content.", + "value": { + "type": "mathsFunctional", + "attributeParameters": [ + { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ], + "defaultContent": { + "curveLabel": "Updated curve label", + "transposeAxes": true, + "useLogarithmicScale": true, + "freeParameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + }, + "parameterContents": [ + { + "type": "numeric", + "value": 15.0, + "parameterRange": { + "lowValue": 5.0, + "highValue": 100.0 + }, + "parameter": { + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "numeric", + "parameterRange": { + "lowValue": -2.0 + }, + "parameter": { + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + }, + { + "type": "discrete", + "parameterRange": { + "parameterValues": [ + { + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + } + ] + }, + "parameter": { + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + } + ] + } + } + }, + "Example 15": { + "summary": "Update tabular columns", + "description": "This example demonstrates how to modify the tabular columns of the 'Legislations restricting its use' attribute from the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "All Legislation Names", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "18eab50a-6c30-4a1d-9205-29878a6044bd" + }, + { + "columnType": "linkedAttribute", + "showAsLink": true, + "summaryRowEnabled": false, + "rollUpType": "min", + "summaryRowRollUpType": "listDistinct", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + { + "columnType": "linkedAttribute", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "0a553cb4-13f2-447b-bc55-3e68e1008b51" + }, + { + "columnType": "localPoint", + "defaultThresholdType": "exists", + "showAsLink": false, + "summaryRowEnabled": false, + "rollUpType": "list", + "summaryRowRollUpType": "list", + "guid": "be3a1aa5-0b35-4d62-b512-a2923ed03e8d" + } + ], + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + } + }, + "Example 16": { + "summary": "Update tabular target", + "description": "This example demonstrates how to modify the tabular target attribute of the 'Legislations restricting its use' attribute from 'Legislation ID' to 'Parent legislation ID'. The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", + "value": { + "type": "link", + "target": { + "targetAttributeGuid": "a581f019-a3ba-41ca-b335-9fb63c417534" + } + } + }, + "Example 17": { + "summary": "Remove tabular target", + "description": "This example demonstrates how to remove the tabular target of the 'Legislations restricting its use' attribute. Linked attribute columns will become 'unavailable'. The target can be reset, then the linked attribute columns will become available. The original target attribute is 'Legislation ID' ('targetAttributeGuid': '77e38bc0-d8ab-484d-a84c-a9ffec81afab') in table 'Legislations and Lists' ('targetTableGuid': '08a1f735-9b37-49bc-96b3-e46e070f6c17'), with 'targetDatabaseGuid' and 'targetDatabaseVersionGuid' for the MI_Training database.The 'Legislations restricting its use' tabular attribute is in the 'Restricted Substances' table from the MI_Training database (tableGuid = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'; attributeGuid = 'c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc').", "value": { - "guid": "a8c0936e-ef54-40f0-9936-993acc3f77eb" + "type": "link", + "target": null } } } @@ -48785,145 +27427,294 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", + "Example 9": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", + }, + "Example 10": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root Exporter folder.", + }, + "Example 11": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot update Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderUpdate", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "4736e6f1-21b9-45fa-a789-0685b53a9a22" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 12": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, { - "message": "You cannot update the root folder.", - "reason": "updateRoot" + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database, table or attribute not found" } } }, "delete": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Delete an Exporter Folder.", - "operationId": "DeleteExportersFolder", + "summary": "Delete an attribute.", + "operationId": "DeleteAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -48934,75 +27725,33 @@ ], "responses": { "400": { - "description": "Bad Request", + "description": "Bad request. Attribute in use.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" + "$ref": "#/components/schemas/GsaAttributeDeletionException" }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root Exporter folder.", - "value": { - "message": "Cannot delete Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderDeletion", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ + "example": { + "message": "Cannot delete attribute 'Tensile strength' (GUID = '000000e3-0001-4fff-8fff-dd92ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in version controlled data.", + "reason": "usage", + "referencedByType": "versionControlledData" + }, + { + "message": "It is being used in one or more expressions.", + "reason": "usage", + "referencedByType": "expression", + "referencedBy": [ { - "message": "You cannot delete the root folder.", - "reason": "root" + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } ] } - } + ] } } } @@ -49014,138 +27763,134 @@ "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database, table or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:child-folders": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Get Child Exporters Folders", - "operationId": "GetExportersChildFolders", + "summary": "Get all meta-attributes in table", + "operationId": "GetMetaAttributes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Abaqus", - "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" - }, - { - "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", - "hasFiles": false, - "hasChildFolders": false, - "name": "Ansys Workbench", - "guid": "92be9c31-7aff-4d96-8069-983390284391" - } - ] + "$ref": "#/components/schemas/GsaAttributesInfo" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/exporters:re-fetch": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}": { + "get": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Re-fetch the Exporter Files.", - "operationId": "RefetchExporters", + "summary": "Get meta-attribute in table", + "operationId": "GetMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "meta-attribute-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -49153,56 +27898,286 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaExporterRefetchInfo" + "$ref": "#/components/schemas/GsaAttribute" + }, + "examples": { + "Example 13": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", + "value": { + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" + } + }, + "Example 14": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 15": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "933aa9de-d6b9-4fe3-92c5-6797a06cd50c" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 16": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + } + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" + } + } } } } }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" + "description": "Database, table or meta-attribute not found" } } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": { - "post": { + }, + "patch": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Move an existing Exporter Folder.", - "operationId": "MoveExportersFolder", + "summary": "Update meta-attribute.", + "operationId": "UpdateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "meta-attribute-guid", "in": "path", "required": true, "schema": { @@ -49215,56 +28190,188 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateAttribute" }, "examples": { "Example 1": { - "summary": "Move Exporter Folder", - "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", "value": { - "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "type": "longText", + "name": "Notes (flammability)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "guid": "12345678-1234-4fff-8fff-0000ffff0000" + } + }, + "Example 3": { + "summary": "Update default threshold type", + "description": "This example demonstrates how to update the default threshold type of the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "defaultThresholdType": "equal" + } + }, + "Example 4": { + "summary": "Update IsHiddenFromSearchCriteria", + "description": "This example demonstrates how to update an attribute so that it should not be shown in search UIs. It will still be included in text searches. The example is for the 'Notes' meta-attribute of the 'Flammability' attribute in the 'MaterialUniverse' table in the MI_Training database(tableGuid: 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid: 00000298-0001-4fff-8fff-dd92ffff0000)", + "value": { + "type": "longText", + "isHiddenFromSearchCriteria": true + } + }, + "Example 5": { + "summary": "Turn a meta-attribute into an attribute", + "description": "This example demonstrates how to turn an existing meta-attribute into an attribute by removing its 'aboutAttribute'. We make the short text 'Notes' meta-attribute of the 'Flammability' attribute from the 'MaterialUniverse' table (tableGuid = 0000dd92-0011-4fff-8fff-0000ffff0000; metaAttributeGuid = 00000298-0001-4fff-8fff-dd92ffff0000) become a standalone attribute.", + "value": { + "type": "longText", + "aboutAttribute": null } } } @@ -49273,237 +28380,448 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", + "Example 17": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", + }, + "Example 18": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 19": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "077035b0-d1d6-4ba6-9484-a47e84060ec0" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 20": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, { - "message": "You cannot move the root folder.", - "reason": "root" + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root Exporter folder.", - "value": { - "message": "Cannot move Exporter folder with GUID 'c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44'.", - "code": "folderMove", - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "folderType": "exporter", - "errors": [ + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or meta-attribute not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Attributes" + ], + "summary": "Delete a meta-attribute.", + "operationId": "DeleteMetaAttribute", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "meta-attribute-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAttributeDeletionException" + }, + "example": { + "message": "Cannot delete attribute 'Notes' (GUID = 'b4b18f0a-ea70-4ca8-a0e8-28613ae76d24').", + "code": 400, + "errors": [ + { + "message": "It is being used in version controlled data.", + "reason": "usage", + "referencedByType": "versionControlledData" + }, + { + "message": "It is being used in one or more search masks.", + "reason": "usage", + "referencedByType": "searchMask", + "referencedBy": [ { - "message": "You cannot move the root folder.", - "reason": "root" + "name": "Search mask that searches in Notes", + "guid": "2c966f78-6782-4b94-9a96-ba92c89accef" } ] } - } + ] } } } }, + "200": { + "description": "OK" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database, table or meta-attribute not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes": { "get": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Get the Exporter Files in a Folder", - "operationId": "GetExportersFiles", + "summary": "Get meta-attributes for attribute", + "operationId": "GetMetaAttributesForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "exporter-1.exp", - "guid": "9dc48e24-1ad1-4420-ab9c-c9d6023f57d3" - }, - { - "name": "no-transform.xslt", - "guid": "fe81c313-4ac9-4739-93de-7b7437417e40" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "exporter-1.exp", - "guid": "9dc48e24-1ad1-4420-ab9c-c9d6023f57d3" - }, - { - "name": "no-transform.xslt", - "guid": "fe81c313-4ac9-4739-93de-7b7437417e40" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "exporter-1.exp", - "guid": "9dc48e24-1ad1-4420-ab9c-c9d6023f57d3" - }, - { - "name": "no-transform.xslt", - "guid": "fe81c313-4ac9-4739-93de-7b7437417e40" - } - ] + "$ref": "#/components/schemas/GsaAttributesInfo" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database, table or attribute not found" } } }, "post": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Create a new Exporter File.", - "operationId": "CreateExportersFile", + "summary": "Create a new meta-attribute for attribute.", + "operationId": "CreateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -49514,25 +28832,71 @@ ], "requestBody": { "content": { - "multipart/form-data": { + "application/json-patch+json": { "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" }, - "encoding": { - "file": { - "style": "form" - }, - "description": { - "style": "form" + "examples": { + "Example 1": { + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateAttribute" + }, + "examples": { + "Example 1": { + "summary": "Short text meta-attribute", + "description": "This example demonstrates how to create a short text meta-attribute for the existing 'EPS Value' attribute (GUID = 000000b9-0001-4fff-8fff-dd92ffff0000 ) in the MaterialUniverse (GUID = 0000dd92-0011-4fff-8fff-0000ffff0000) table of the MI_Training database.", + "value": { + "type": "shortText", + "isUnique": false, + "defaultThresholdType": "exists", + "name": "Short Label" + } } } } @@ -49542,147 +28906,283 @@ "201": { "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ecb1f22-5c34-4c46-9167-7011b87f1dc7" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ecb1f22-5c34-4c46-9167-7011b87f1dc7" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ecb1f22-5c34-4c46-9167-7011b87f1dc7" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "$ref": "#/components/schemas/GsaAttribute" }, "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", + "Example 25": { + "summary": "Date-time attribute", + "description": "Example response for the date-time attribute 'Casting Date' in the 'Metals Pedigree' table of the 'MI Training database'.", "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" - } - ] + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "DAT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Casting Date", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "dateTime", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "ad27baf0-42e9-4136-bc96-9dbbf116e265" + }, + "displayNames": { + "fr": "Casting Date French Display Name" + }, + "name": "Casting Date", + "guid": "fe9cbde6-756a-4b1d-a347-7d49e56ee90f" } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", + }, + "Example 26": { + "summary": "Discrete attribute", + "description": "Example response for the discrete attribute 'Metals' in the 'Materials Universe' table of the 'MI Training database'.", "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", - "errors": [ + "discreteType": { + "name": "MU Durability", + "guid": "00000083-0006-4fff-8fff-0000ffff0000" + }, + "isMultiValued": false, + "defaultThresholdType": "atLeast", + "helpPath": "html/attributenotes/metals.html", + "info": { + "typeCode": "DCT", + "chartable": false, + "expressionable": false, + "linkable": true, + "extendedName": "Metals", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 27": { + "summary": "Range attribute", + "description": "Example response for the range attribute 'Tensile strength' in the 'Materials Universe' table of the 'MI Training database'.", + "value": { + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "defaultThresholdType": "atLeast", + "info": { + "typeCode": "RNG", + "chartable": true, + "expressionable": true, + "linkable": true, + "extendedName": "Tensile strength", + "isMetaAttribute": false, + "orderedMetaAttributes": [ + { + "type": "longText", + "name": "Notes", + "guid": "8d7c8bb0-450f-4f9d-a717-ea4f5b56df74" + } + ], + "standardNames": [ + { + "name": "Tensile strength", + "guid": "a5a22baa-2245-4fb5-b0c9-2ddb48b5ffc8" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [ + { + "name": "Source of data (MaterialUniverse)", + "guid": "748f737f-e59f-449a-b862-34240ebddb58" + } + ], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + } + }, + "Example 28": { + "summary": "Tabular attribute", + "description": "Example response for the tabular attribute 'Restricted substances associated with this material' in the 'Materials Universe' table of the 'MI Training database'..", + "value": { + "displayFullTable": false, + "displaySummaryRowInline": false, + "hideUnlinkedRows": true, + "target": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", + "targetAttributeGuid": "446d4fc3-f902-4875-9e48-6df9a691c2b0" + }, + "tabularColumns": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Chemical name", + "guid": "5555b6f5-d492-4efd-bfe3-3e9faf79ab07" + }, + "showAsLink": true, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Substance name", + "guid": "94c07750-4710-402b-aefd-4b7f8831a0a0" + }, + { + "columnType": "localRange", + "defaultThresholdType": "atLeast", + "unit": { + "symbol": "%", + "guid": "00000005-0013-4fff-8fff-0000ffff0000" + }, + "showAsLink": false, + "summaryRowEnabled": false, + "summaryRowText": "", + "rollUpType": "list", + "summaryRowRollUpType": "list", + "displayNames": {}, + "name": "Amount", + "guid": "5fc69b42-8bf0-4867-befa-4101cf12842b" + }, + { + "columnType": "linkedColumn", + "linkedAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + }, + "name": "Legislations restricting its use", + "guid": "c33cecb7-f3d2-4415-9de6-1ed4e5b2abdc" + }, + "linkedColumn": { + "columnType": "linkedAttribute", + "linkedAttribute": { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "08a1f735-9b37-49bc-96b3-e46e070f6c17" + }, + "name": "Rating", + "guid": "5d7b7b7e-b666-4279-9964-2f28c4123c45" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "Substance ES&H rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "49a720bd-55c4-44a3-a10a-5ae3b69f3100" + }, + "linkedTarget": { + "targetDatabaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "targetDatabaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "targetTableGuid": "08a1f735-9b37-49bc-96b3-e46e070f6c17", + "targetAttributeGuid": "77e38bc0-d8ab-484d-a84c-a9ffec81afab" + }, + "showAsLink": false, + "summaryRowEnabled": true, + "summaryRowText": "EH&S rating", + "rollUpType": "list", + "summaryRowRollUpType": "min", + "displayNames": {}, + "name": "Legislation rating", + "guid": "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" } - ] + ], + "defaultThresholdType": "exists", + "info": { + "typeCode": "TABL", + "chartable": false, + "expressionable": false, + "linkable": false, + "extendedName": "Restricted substances associated with this material", + "isMetaAttribute": false, + "orderedMetaAttributes": [], + "standardNames": [ + { + "name": "Restricted substances in this item", + "guid": "315d8839-ab9d-4b31-a27d-c128ebf34150" + } + ], + "primaryDataLinkGroups": [], + "foreignDataLinkGroups": [], + "primaryDynamicLinkGroups": [], + "foreignDynamicLinkGroups": [] + }, + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "displayNames": {}, + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } } } - }, - "text/json": { + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" + "$ref": "#/components/schemas/GsaAttributeCreationException" }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create an Exporter file with name 'AbaqusFunctions.xsl' in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff'), but there is already a file with that name and parent.", - "value": { - "message": "Cannot create Exporter file 'AbaqusFunctions.xsl'.", - "code": "fileCreation", - "name": "AbaqusFunctions.xsl", - "folderType": "exporter", + "example": { + "message": "Cannot create meta-attribute 'Notes'.", + "code": 400, + "errors": [ + { + "message": "The name or GUID is not valid.", "errors": [ { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" + "message": "Meta-attribute with GUID '02372af3-2cf5-401d-ab8c-ee15978df1b9' already exists.", + "guid": "02372af3-2cf5-401d-ab8c-ee15978df1b9", + "reason": "entityAlreadyExists", + "entityTypeName": "Meta-attribute" } - ] + ], + "reason": "namedEntity" + }, + { + "message": "Cannot have a meta-attribute as an 'About attribute'.", + "reason": "aboutAttributeCannotBeMeta" } - } + ] } } } @@ -49691,32 +29191,29 @@ "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database, table or attribute not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}:validate": { + "post": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Get the header information for an Exporter File", - "operationId": "GetExporterFile", + "summary": "Validates the provided value against the attributes data rules.", + "operationId": "ValidateAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -49725,7 +29222,7 @@ } }, { - "name": "file-guid", + "name": "attribute-guid", "in": "path", "required": true, "schema": { @@ -49734,545 +29231,906 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + } + } + }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "6dd8c96e-b1fb-46a2-8986-18b7c6e4b2ad" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "6dd8c96e-b1fb-46a2-8986-18b7c6e4b2ad" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "6dd8c96e-b1fb-46a2-8986-18b7c6e4b2ad" + "$ref": "#/components/schemas/GsaAttributeValidateResponse" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, folder or file not found" + "description": "Database, table or attribute not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes/{meta-attribute-guid}:validate": { + "post": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Update an existing Exporter File.", - "operationId": "UpdateExportersFile", + "summary": "Validates the provided value against the meta attributes data rules.", + "operationId": "ValidateMetaAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "meta-attribute-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaValidateAttributeRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAttributeValidateResponse" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or meta-attribute not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes:query": { + "post": { + "tags": [ + "Schema - Attributes" + ], + "summary": "Get attributes in table, populate the requested properties. Optionally filter the returned attributes.", + "operationId": "QueryAttributes", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "file-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "name": "New File Name" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 3": { + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } + } + }, + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } + } + }, + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", + "value": { + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } + } + }, + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all attributes with unit and meta attributes", + "value": { + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 3": { + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } + } + }, + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "description": "New description for Exporter file." + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } } }, - "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "guid": "4fbb4c09-1a65-4525-a14a-93fac6ae6a2d" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "name": "New File Name" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "summary": "Fetch all attributes with custom properties", "value": { - "description": "New description for Exporter file." + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true + } + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", "value": { - "guid": "4fbb4c09-1a65-4525-a14a-93fac6ae6a2d" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" + ] + } } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" - }, - "examples": { - "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + }, + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", "value": { - "name": "New File Name" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", "value": { - "description": "New description for Exporter file." + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } } }, - "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "guid": "4fbb4c09-1a65-4525-a14a-93fac6ae6a2d" + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Rename Exporter File", - "description": "This example demonstrates how to rename an existing Exporter file.", + "summary": "Fetch all attributes with unit and meta attributes", "value": { - "name": "New File Name" + "properties": { + "type": true, + "info": { + "orderedMetaAttributes": { + "type": true, + "name": true + } + }, + "unit": { + "symbol": true + }, + "name": true, + "guid": true + } } }, "Example 2": { - "summary": "Modify the description for an Exporter File", - "description": "This example demonstrates how to change the description for an existing Exporter file.", - "value": { - "description": "New description for Exporter file." - } - }, - "Example 3": { - "summary": "Change guid for Exporter File", - "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "summary": "Fetch all attributes with custom properties", "value": { - "guid": "4fbb4c09-1a65-4525-a14a-93fac6ae6a2d" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "ba2e4f45-d286-43ef-9093-3ea58843deef" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "ba2e4f45-d286-43ef-9093-3ea58843deef" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "ba2e4f45-d286-43ef-9093-3ea58843deef" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID '9b949b03-b775-4c05-aec0-f7d4ae979f05'.", - "code": "fileUpdate", - "fileGuid": "9b949b03-b775-4c05-aec0-f7d4ae979f05", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true, + "orderedMetaAttributes": { + "type": true, + "name": true, + "guid": true } - ] + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true } } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID '9b949b03-b775-4c05-aec0-f7d4ae979f05'.", - "code": "fileUpdate", - "fileGuid": "9b949b03-b775-4c05-aec0-f7d4ae979f05", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" - } + "Example 3": { + "summary": "Fetch all tabular attributes, with tabular columns and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "link" ] } } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" }, - "examples": { - "Example 1": { - "summary": "File with same name already exists", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename an Exporter file in the 'Abaqus' folder (GUID '41aba877-8fe0-4295-bddb-6f8b270a40ff') to have name 'AbaqusFunctions.xsl', but there is already a file with that name and parent.", - "value": { - "message": "Cannot update Exporter file with GUID '9b949b03-b775-4c05-aec0-f7d4ae979f05'.", - "code": "fileUpdate", - "fileGuid": "9b949b03-b775-4c05-aec0-f7d4ae979f05", - "folderType": "exporter", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "File with name 'AbaqusFunctions.xsl' already exists in this Folder.", - "name": "AbaqusFunctions.xsl", - "parentEntityType": "folder", - "reason": "nameAlreadyExists", - "entityType": "file" - } - ], - "reason": "namedEntity" - } + "Example 4": { + "summary": "Fetch all short text or long text attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Delete an Exporter File.", - "operationId": "DeleteExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:export": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Exporter folder and contents as a zip file", - "operationId": "ExportExportersFolder", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + } + } + }, + "Example 5": { + "summary": "Fetch attribute with name \"Young's modulus\"", + "value": { + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Young's modulus" + ] + } + } + }, + "Example 6": { + "summary": "Fetch attributes with matching GUID", + "description": "This example demonstrates how to find attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "0000003f-0001-4fff-8fff-dd92ffff0000", + "000000e3-0001-4fff-8fff-dd92ffff0000" + ] + } + } + } + } } } - ], + }, "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "application/zip": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaQueryAttributesInfo" } } - }, - "x-is-file": true - }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:export": { - "get": { - "tags": [ - "Schema - Exporters" - ], - "summary": "Get Exporter File as a file", - "operationId": "ExportExportersFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" } }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } + "400": { + "description": "Bad request" }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "x-is-file": true + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Table not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:move": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/meta-attributes:query": { "post": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Move an existing Exporter File.", - "operationId": "MoveExportersFile", + "summary": "Get meta-attributes in table, populate the requested properties. Optionally filter the returned meta-attributes.", + "operationId": "QueryMetaAttributes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -50281,12 +30139,27 @@ } }, { - "name": "file-guid", - "in": "path", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -50294,285 +30167,676 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "summary": "Fetch all meta-attributes", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } + } + }, + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } + } + }, + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all meta-attributes", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } + } + }, + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } + } + }, + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all meta-attributes", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + }, + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaMoveFile" - }, - "examples": { - "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + }, + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { "Example 1": { - "summary": "Move Exporter File", - "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "summary": "Fetch all meta-attributes", "value": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "0c972001-311a-4779-a218-39f1cf65d350" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "0c972001-311a-4779-a218-39f1cf65d350" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "0c972001-311a-4779-a218-39f1cf65d350" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" + "Example 2": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID '944ce0eb-73a7-416d-a4bf-d17db11eb43a'.", - "code": "fileMove", - "fileGuid": "944ce0eb-73a7-416d-a4bf-d17db11eb43a", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d' does not exist in database MI_Training.", - "folderGuid": "63077d99-d1bd-43a6-a0b4-eb5cd2c7908d", - "folderType": "exporter", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } + "Example 3": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" ] } } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID '944ce0eb-73a7-416d-a4bf-d17db11eb43a'.", - "code": "fileMove", - "fileGuid": "944ce0eb-73a7-416d-a4bf-d17db11eb43a", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d' does not exist in database MI_Training.", - "folderGuid": "63077d99-d1bd-43a6-a0b4-eb5cd2c7908d", - "folderType": "exporter", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } + "Example 4": { + "summary": "Fetch meta-attributes with name \"Notes\"", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" ] } } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d', but there is no Exporter folder with that GUID.", - "value": { - "message": "Cannot move Exporter file with GUID '944ce0eb-73a7-416d-a4bf-d17db11eb43a'.", - "code": "fileMove", - "fileGuid": "944ce0eb-73a7-416d-a4bf-d17db11eb43a", - "folderType": "exporter", - "errors": [ - { - "message": "A Exporter folder with GUID '63077d99-d1bd-43a6-a0b4-eb5cd2c7908d' does not exist in database MI_Training.", - "folderGuid": "63077d99-d1bd-43a6-a0b4-eb5cd2c7908d", - "folderType": "exporter", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } + "Example 5": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" ] } } } } } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaQueryAttributesInfo" + } + } + } + }, + "400": { + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Table not found" } } } }, - "/v1alpha/databases/{database-key}/exporters/{folder-guid}:descendants": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/attributes/{attribute-guid}/meta-attributes:query": { + "post": { "tags": [ - "Schema - Exporters" + "Schema - Attributes" ], - "summary": "Returns file information for all descendants of an Exporter folder.", - "operationId": "GetExporterDescendants", + "summary": "Get meta-attributes for attribute, populate the requested properties. Optionally filter the returned meta-attributes.", + "operationId": "QueryMetaAttributesForAttribute", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - } - } - }, - "404": { - "description": "Database or folder not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": { - "get": { - "tags": [ - "Schema - Expressions" - ], - "summary": "Get all expressions for table", - "operationId": "GetExpressions", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "table-guid", + "name": "attribute-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -50601,207 +30865,620 @@ } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaExpressionsInfo" - }, - "examples": { - "Example 1": { - "summary": "Get all expressions", - "description": "This example demonstrates the response to getting all expressions from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "expressions": [ - { - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - }, - "post": { - "tags": [ - "Schema - Expressions" - ], - "summary": "Create a new expression.", - "operationId": "CreateExpression", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - } - ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { - "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "Example 6": { + "summary": "Fetch all meta-attributes", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } + } + }, + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "107089a5-f4cb-4491-bc0b-79321b3e7307" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "name": "Simple expression with specified unit" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { - "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "107089a5-f4cb-4491-bc0b-79321b3e7307" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true }, - "name": "Simple expression with specified unit" + "filter": { + "type": [ + "shortText", + "longText" + ] + } + } + }, + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } + } + }, + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { - "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } } }, - "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "107089a5-f4cb-4491-bc0b-79321b3e7307" + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } } }, - "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true }, - "name": "Simple expression with specified unit" + "filter": { + "type": [ + "shortText", + "longText" + ] + } + } + }, + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } + } + }, + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", + "value": { + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateExpression" + "$ref": "#/components/schemas/GsaQueryAttributesRequest" }, "examples": { - "Example 1": { - "summary": "Expression", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", + "Example 6": { + "summary": "Fetch all meta-attributes", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + } + } + }, + "Example 7": { + "summary": "Fetch all meta-attributes with custom properties", + "value": { + "properties": { + "type": true, + "defaultThresholdType": true, + "isHiddenFromSearchCriteria": true, + "isMultiValued": true, + "isFunctionalRange": true, + "axisName": { + "name": true, + "displayNames": true + }, + "info": { + "chartable": true + }, + "unit": { + "name": true, + "symbol": true, + "relativeSymbol": true, + "equation": true, + "guid": true + }, + "discreteType": { + "isOrdered": true, + "name": true, + "guid": true + }, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true, + "guid": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "target": { + "targetDatabaseGuid": true, + "targetDatabaseVersionGuid": true, + "targetTableGuid": true, + "targetAttributeGuid": true + }, + "tabularColumns": { + "name": true, + "guid": true + }, + "attributeParameters": { + "name": true, + "guid": true + }, + "expressions": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 8": { + "summary": "Fetch all short text or long text meta-attributes, with data rule and other custom properties", + "value": { + "properties": { + "type": true, + "isHiddenFromSearchCriteria": true, + "dataRule": { + "description": true, + "regularExpression": true, + "name": true + }, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + }, + "filter": { + "type": [ + "shortText", + "longText" + ] + } } }, - "Example 2": { - "summary": "Expression with specified guid", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 9": { + "summary": "Fetch meta-attributes with name \"Notes\"", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "name": "Simple expression with specified guid", - "guid": "107089a5-f4cb-4491-bc0b-79321b3e7307" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Notes" + ] + } } }, - "Example 3": { - "summary": "Expression with specified unit", - "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", + "Example 10": { + "summary": "Fetch meta-attributes with matching GUID", + "description": "This example demonstrates how to find meta-attributes by GUID in table 'MaterialUniverse' (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from database 'MI Training'.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "00000059-0013-4fff-8fff-0000ffff0000" + "properties": { + "type": true, + "aboutAttribute": { + "type": true, + "name": true, + "guid": true + }, + "name": true, + "guid": true }, - "name": "Simple expression with specified unit" + "filter": { + "guid": [ + "05dc05c6-7e15-4790-81e2-34d4ea8750a8" + ] + } } } } @@ -50809,93 +31486,12 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" - }, - "examples": { - "Example 2": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - } + "$ref": "#/components/schemas/GsaQueryAttributesInfo" } } } @@ -50907,70 +31503,38 @@ "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Attribute not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": { + "/v1alpha/databases/{database-key}/configurations/{configuration-type}": { "get": { "tags": [ - "Schema - Expressions" + "Schema - Configurations" ], - "summary": "Get an expression with a specified guid for a given database and table.", - "operationId": "GetExpression", + "summary": "Get all configurations of given type", + "operationId": "GetConfigurations", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "expression-guid", + "name": "configuration-type", "in": "path", + "description": "The configuration type.", "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { "enum": [ - "read", - "write" + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" ], "type": "string" } @@ -50982,133 +31546,52 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" + "$ref": "#/components/schemas/GsaConfigurationsInfo" }, - "examples": { - "Example 1": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + "example": { + "configurations": [ + { + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } - } + ] } } } }, "404": { - "description": "Database, table or expression not found" + "description": "Database not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Expressions" + "Schema - Configurations" ], - "summary": "Update an expression.", - "operationId": "UpdateExpression", + "summary": "Create a new configuration.", + "operationId": "CreateConfiguration", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "expression-guid", + "name": "configuration-type", "in": "path", + "description": "The configuration type.", "required": true, "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" } } ], @@ -51116,104 +31599,100 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaCreateConfiguration" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "a9cf7df0-930b-4add-b807-1e375ab2a0f8" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "name": "Fatigue Model (Updated)" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "448a7e40-9d9a-4f3e-a265-40353ea2e881" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaCreateConfiguration" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "a9cf7df0-930b-4add-b807-1e375ab2a0f8" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "name": "Fatigue Model (Updated)" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "448a7e40-9d9a-4f3e-a265-40353ea2e881" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaCreateConfiguration" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "a9cf7df0-930b-4add-b807-1e375ab2a0f8" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "name": "Fatigue Model (Updated)" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "448a7e40-9d9a-4f3e-a265-40353ea2e881" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateExpression" + "$ref": "#/components/schemas/GsaCreateConfiguration" }, "examples": { "Example 1": { - "summary": "Everything for an expression", - "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", + "summary": "Configuration", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database.", "value": { - "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model (Updated)", - "guid": "a9cf7df0-930b-4add-b807-1e375ab2a0f8" + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration" } }, "Example 2": { - "summary": "Rename expression", - "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Configuration with specified guid and description", + "description": "This example demonstrates how to create a new Explore configuration for the MI_Training database with a specified guid and description. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "name": "Fatigue Model (Updated)" + "description": "Basic configuration that can be used in explore.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "basic configuration", + "guid": "448a7e40-9d9a-4f3e-a265-40353ea2e881" } } } @@ -51221,150 +31700,20 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaExpression" + "$ref": "#/components/schemas/GsaConfiguration" }, - "examples": { - "Example 3": { - "summary": "Get expression", - "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", - "value": { - "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", - "unit": { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - "attributeDependencies": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Young's modulus", - "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Tensile strength", - "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue strength at 10^7 cycles", - "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Elongation", - "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - } - ], - "constantDependencies": [], - "parameterDependencies": [ - { - "name": "Number of Cycles", - "guid": "00000007-000a-4fff-8fff-0000ffff0000" - }, - { - "name": "Stress Ratio", - "guid": "00000004-000a-4fff-8fff-0000ffff0000" - } - ], - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Fatigue Model", - "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" - } - } + "example": { + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or expression not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Expressions" - ], - "summary": "Delete an expression.", - "operationId": "DeleteExpression", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "expression-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" + } }, "400": { "description": "Bad request" @@ -51373,43 +31722,44 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or expression not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}/permission-category-access-controls": { + "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}": { "get": { "tags": [ - "Schema - Expressions" + "Schema - Configurations" ], - "summary": "Get permission-based access control settings for a given expression.\r\nReturns the access control for each permission in each category.", - "operationId": "GetExpressionPermissionCategoryAccessControls", + "summary": "Get individual configuration", + "operationId": "GetConfiguration", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "configuration-type", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The configuration type.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" } }, { - "name": "expression-guid", + "name": "configuration-guid", "in": "path", "required": true, "schema": { @@ -51424,106 +31774,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaConfiguration" }, "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, table or expression not found" - }, - "422": { - "description": "MI not in permission-based access control mode" + "description": "Database or configuration not found" } } }, "patch": { "tags": [ - "Schema - Expressions" + "Schema - Configurations" ], - "summary": "Update permission-based access control settings for a given expression.\r\nSets the access control for the given permissions.", - "operationId": "UpdateExpressionPermissionCategoryAccessControls", + "summary": "Update a configuration.", + "operationId": "UpdateConfiguration", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "configuration-type", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "The configuration type.", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" } }, { - "name": "expression-guid", + "name": "configuration-guid", "in": "path", "required": true, "schema": { @@ -51536,340 +31833,96 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateConfiguration" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "ba6319ba-7b51-44d2-82d5-473f37e7ea8e" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "examples (updated)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateConfiguration" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "ba6319ba-7b51-44d2-82d5-473f37e7ea8e" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "examples (updated)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateConfiguration" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "ba6319ba-7b51-44d2-82d5-473f37e7ea8e" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "examples (updated)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" + "$ref": "#/components/schemas/GsaUpdateConfiguration" }, "examples": { - "Example 7": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", + "Example 1": { + "summary": "Everything for a configuration", + "description": "This example shows how to update all properties of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] + "description": "Updated description for MI_Training Explore 'examples' configuration.", + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples (updated)", + "guid": "ba6319ba-7b51-44d2-82d5-473f37e7ea8e" } }, - "Example 8": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", + "Example 2": { + "summary": "Update a name", + "description": "This example shows how to update the 'Name' property of the Explore 'examples' configuration (guid = 997e8f58-bd2a-494f-9a99-18b3d395ad0a) from the MI_Training database.", "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "name": "examples (updated)" } } } @@ -51882,166 +31935,143 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaConfiguration" }, "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] + "value": "{\"configurations\": [{\"key\": \"training-materials\",\"displayName\": \"MI Training Materials\",\"default\": true,\"groups\": [\"MI Training examples\"],\"table\": \"MaterialUniverse\",\"loadDataOnDemand\": false,\"description\": \"Explore MaterialUniverse data in the MI Training database\",\"searchLayout\": \"All bulk materials\",\"dataSheetLayout\": \"All bulk materials\",\"editableDatasheetLayout\": \"All bulk materials\",\"searchListLayout\": \"Explore list layout Materials\",\"newRecordLocation\": \"NEW RECORDS/{Base}\",\"subset\": \"All bulk materials\",\"logsliders\": true,\"xyChart\": {\"colorAttribute\": \"UV radiation (sunlight)\",\"colorAttribute2\": \"Flammability\",\"colorAttribute3\": \"Food contact\",\"colorAttribute4\": \"Material form\",\"colorAttribute5\": \"Organic solvents\",\"colorAttribute6\": \"Oxidation at 500C\",\"colorAttribute7\": \"Strong acids\",\"colorAttribute8\": \"Strong alkalis\",\"colorAttribute9\": \"Weak acids\",\"colorAttribute10\": \"Weak alkalis\",\"colorAttribute11\": \"Water (fresh)\",\"colorAttribute12\": \"Water (salt)\",\"colorAttribute13\": \"Transparency\",\"colorAttribute14\": \"Wear resistance\",\"xAttribute\": \"Density\",\"yAttribute\": \"Yield strength (elastic limit)\",\"preventAxisChange\": false,\"xAxisLogarithmic\": true,\"yAxisLogarithmic\": true},\"showBlanks\": false,\"reportsDisabled\": false,\"exportersDisabled\": false,\"tabularEditingEnabled\": true,\"configSwitching\": \"keyOnly\",\"workflowEnabled\": true,\"useCustomFormatters\": {\"Recycle fraction in current supply\": \"recyclingPercent\",\"Recycle\": \"recyclingBool\",\"Biodegrade\": \"biodegradeBool\",\"UV radiation (sunlight)\": \"uvradiationsunlightDiscrete\",\"Flammability\": \"flammabilityDiscrete\",\"Food contact\": \"foodcontactDiscrete\",\"Material form\": \"materialformDiscrete\",\"Organic solvents\": \"organicsolventsDiscrete\",\"Oxidation at 500C\": \"oxidationat500cDiscrete\",\"Strong acids\": \"strongacidsDiscrete\",\"Strong alkalis\": \"strongalkalisDiscrete\",\"Weak acids\": \"weakacidsDiscrete\",\"Weak alkalis\": \"weakalkalisDiscrete\",\"Water (fresh)\": \"waterfreshDiscrete\",\"Water (salt)\": \"watersaltDiscrete\",\"Transparency\": \"transparencyDiscrete\",\"Wear resistance\": \"wearresistanceDiscrete\",\"A renewable resource?\": \"arenewableresourceBool\",\"Combust for energy recovery\": \"combustforenergyrecoveryBool\",\"Downcycle\": \"downcycleBool\",\"Flame retardant additive\": \"flameretardantadditiveBool\",\"Landfill\": \"landfillBool\",\"RoHS (EU) compliant grades?\": \"rohseucompliantgradesBool\",\"Substance declaration available?\": \"substancedeclarationavailableBool\"}}],\"customFormatterDefinitions\": {\"recyclingBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleYes.png\",\"tooltipValue\": \"Can be recycled\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/RecycleNo.png\",\"tooltipValue\": \"Can not be recycled\"},\"chart\": {\"renderColor\": \"red\"}}]},\"biodegradeBool\": {\"attributeFormatter\": {\"list\": {\"columnHeader\": false,\"columnWidth\": 40}},\"valueFormatters\": [{\"match\": true,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafGreen.png\",\"tooltipValue\": \"Can be biodegraded\"},\"chart\": {\"renderColor\": \"green\"}},{\"match\": false,\"list\": {\"iconUrl\": \"/mi_servicelayer/Assets/v1.svc/HelpPageFiles/MI_Training/ExploreImages/LeafRed.png\",\"tooltipValue\": \"Can not be biodegraded\"},\"chart\": {\"renderColor\": \"red\"}}]}}}", + "name": "examples", + "guid": "997e8f58-bd2a-494f-9a99-18b3d395ad0a" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" - }, - "examples": { - "Example 13": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID 'ed17cdf6-4713-43d7-b28a-799cfd7786ec', but the permission category does not exist.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission category with GUID 'ed17cdf6-4713-43d7-b28a-799cfd7786ec' does not exist.", - "categoryGuid": "ed17cdf6-4713-43d7-b28a-799cfd7786ec", - "reason": "noSuchCategory" - } - ] - } - }, - "Example 14": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '890278ab-94fe-4e28-ada9-8d2bdffa02f9' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "The permission with GUID '890278ab-94fe-4e28-ada9-8d2bdffa02f9' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "permissionGuid": "890278ab-94fe-4e28-ada9-8d2bdffa02f9", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "reason": "noSuchPermission" - } - ] - } - }, - "Example 15": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ], - "reason": "duplicateCategoryGuids" - } - ] - } - }, - "Example 16": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ], - "reason": "duplicatePermissionGuids" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or expression not found" + "description": "Database or configuration not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Configurations" + ], + "summary": "Delete a configuration", + "operationId": "DeleteConfiguration", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "MI not in permission-based access control mode" + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + }, + { + "name": "configuration-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or configuration not found" } } } }, - "/v1alpha/standard-names": { + "/v1alpha/databases/{database-key}/configurations/{configuration-type}/{configuration-guid}:export": { "get": { "tags": [ - "Schema - Global Standard Names" + "Schema - Configurations" ], - "summary": "Gets all standard names from all databases, optionally filtered by the provided 'name' query parameter.", - "operationId": "GetGlobalStandardNames", + "summary": "Get individual configuration as a file", + "operationId": "ExportConfiguration", "parameters": [ { - "name": "name", - "in": "query", - "description": "Standard name to match. Optional.", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration-type", + "in": "path", + "description": "The configuration type.", + "required": true, + "schema": { + "enum": [ + "explore", + "proExplore", + "bomAnalyzer", + "materialModelPicker" + ], + "type": "string" + } + }, + { + "name": "configuration-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database or configuration not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/constants": { + "get": { + "tags": [ + "Schema - Constants" + ], + "summary": "Get all constants", + "operationId": "GetConstants", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -52053,76 +32083,239 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" + "$ref": "#/components/schemas/GsaConstantsInfo" + }, + "example": { + "constants": [ + { + "name": "PI", + "guid": "00000001-0004-4fff-8fff-0000ffff0000" + }, + { + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" + } + ] } } } + }, + "404": { + "description": "Database not found" } } - } - }, - "/v1alpha/standard-names:search": { + }, "post": { "tags": [ - "Schema - Global Standard Names" + "Schema - Constants" + ], + "summary": "Create a new constant.", + "operationId": "CreateConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be created", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Find all standard names from all databases that match one of the names provided in the request.", - "operationId": "FindGlobalStandardNames", "requestBody": { + "description": "Constant to add to database", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant" + } + }, + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "fbd16f3a-2176-4635-94fb-0a59afc75f53" + } + }, + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant" + } + }, + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "fbd16f3a-2176-4635-94fb-0a59afc75f53" + } + }, + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant" + } + }, + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "fbd16f3a-2176-4635-94fb-0a59afc75f53" + } + }, + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaFindStandardNames" + "$ref": "#/components/schemas/GsaCreateConstant" + }, + "examples": { + "Example 1": { + "summary": "Constant", + "description": "This example demonstrates how to create a new constant for the MI_Training database.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant" + } + }, + "Example 2": { + "summary": "Constant with specified guid", + "description": "This example demonstrates how to create a new constant for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": 0.0072973525693, + "name": "fine-structure constant (guid)", + "guid": "fbd16f3a-2176-4635-94fb-0a59afc75f53" + } + }, + "Example 3": { + "summary": "Constant with specified unit", + "description": "This example demonstrates how to create a new constant with a specified unit 'ohm' from the MI_Training database.", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum (guid and unit)" + } + } } } } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" + "$ref": "#/components/schemas/GsaConstant" + }, + "example": { + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders": { + "/v1alpha/databases/{database-key}/constants/{constant-guid}": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Constants" ], - "summary": "Get All Help File Folders", - "operationId": "GetHelpFolders", + "summary": "Get individual constant", + "operationId": "GetConstant", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of requested constant", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -52130,198 +32323,181 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "$ref": "#/components/schemas/GsaConstant" }, "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" - }, - { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" } } } }, "404": { - "description": "Database not found" + "description": "Database or constant not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Help Files" + "Schema - Constants" ], - "summary": "Create a new Help File Folder.", - "operationId": "CreateHelpFolder", + "summary": "Update constant.", + "operationId": "UpdateConstant", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of constant to update", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "requestBody": { + "description": "Constant data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "f56e9cdb-630e-4c0a-977a-711ed7c5ab5e" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "characteristic impedance of vacuum" + } + }, + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "940b8211-5013-45ee-a2c3-cec10fdc7715" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "f56e9cdb-630e-4c0a-977a-711ed7c5ab5e" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "characteristic impedance of vacuum" + } + }, + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "940b8211-5013-45ee-a2c3-cec10fdc7715" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "f56e9cdb-630e-4c0a-977a-711ed7c5ab5e" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "characteristic impedance of vacuum" + } + }, + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "940b8211-5013-45ee-a2c3-cec10fdc7715" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaUpdateConstant" }, "examples": { "Example 1": { - "summary": "Help File Folder", - "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", + "summary": "Everything for a constant", + "description": "This example shows how to update all properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "name": "New Folder" + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "value": 376.730313668, + "name": "characteristic impedance of vacuum", + "guid": "f56e9cdb-630e-4c0a-977a-711ed7c5ab5e" + } + }, + "Example 2": { + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "characteristic impedance of vacuum" + } + }, + "Example 3": { + "summary": "Update guid and unit", + "description": "This example shows how to update the 'Guid' and 'Unit' properties of the 'Speed of light in Vacuum' constant (guid = 0000000f-0004-4fff-8fff-0000ffff0000) from the MI_Training database. Its unit is changed to 'Ohm'", + "value": { + "unitGuid": "00000059-0013-4fff-8fff-0000ffff0000", + "guid": "940b8211-5013-45ee-a2c3-cec10fdc7715" } } } @@ -52329,240 +32505,261 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" + "$ref": "#/components/schemas/GsaConstant" }, "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "unit": { + "symbol": "m/s", + "guid": "00000097-0013-4fff-8fff-0000ffff0000" + }, + "value": 300000000.0, + "name": "Speed of Light in Vacuum", + "guid": "0000000f-0004-4fff-8fff-0000ffff0000" } } } }, "400": { - "description": "Bad request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or constant not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Constants" + ], + "summary": "Delete a constant", + "operationId": "DeleteConstant", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which constant will be search for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "constant-guid", + "in": "path", + "description": "Guid of constant to delete", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "400": { + "description": "Bad request. Constant in use.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", - "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", - "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" + "$ref": "#/components/schemas/GsaConstantDeletionException" }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage folder with name ''.", - "value": { - "message": "Cannot create HelpPage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "helpPage", - "errors": [ + "example": { + "message": "Cannot delete constant 'PI' (GUID = '00000001-0004-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more expressions.", + "reason": "usage", + "referencedByType": "expression", + "referencedBy": [ { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } ] } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + ] } } } }, + "200": { + "description": "Ok" + }, "403": { - "description": "Forbidden" + "description": "Forbidden." + }, + "404": { + "description": "Database or constant not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/data-rules": { + "get": { + "tags": [ + "Schema - Data Rules" + ], + "summary": "Gets all data rules for a given database.", + "operationId": "GetDataRules", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDataRulesInfo" + } + } + } }, "404": { "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders:root-folder": { - "get": { + }, + "post": { "tags": [ - "Schema - Help Files" + "Schema - Data Rules" ], - "summary": "Get Root Help File Folder", - "operationId": "GetHelpRootFolder", + "summary": "Create a new data rule", + "operationId": "CreateDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" + }, + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", + "value": { + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" + } } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", + "value": { + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" + }, + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", + "value": { + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" + } } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateDataRule" }, - "text/json": { + "examples": { + "Example 1": { + "summary": "Data rule for attributes", + "description": "This example demonstrates how to create a new data rule.", + "value": { + "description": "Only numeric digits are allowed.", + "regularExpression": "^[0-9]*$", + "name": "digits only" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Help Pages", - "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "$ref": "#/components/schemas/GsaDataRule" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}": { + "/v1alpha/databases/{database-key}/data-rules/{data-rule-guid}": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Data Rules" ], - "summary": "Get Help File Folder", - "operationId": "GetHelpFolder", + "summary": "Gets a data rule for a given database and guid.", + "operationId": "GetDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "data-rule-guid", "in": "path", "required": true, "schema": { @@ -52575,69 +32772,35 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "hasFiles": false, - "hasChildFolders": false, - "name": "html", - "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + "$ref": "#/components/schemas/GsaDataRule" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database or data rule not found" } } }, "patch": { "tags": [ - "Schema - Help Files" + "Schema - Data Rules" ], - "summary": "Update an existing Help File Folder.", - "operationId": "UpdateHelpFolder", + "summary": "Edit a data rule", + "operationId": "UpdateDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "data-rule-guid", "in": "path", "required": true, "schema": { @@ -52650,86 +32813,22 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", - "value": { - "guid": "e08ad80d-2850-46d2-a4e6-cacb1df19ae9" - } - } + "$ref": "#/components/schemas/GsaUpdateDataRule" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", - "value": { - "guid": "e08ad80d-2850-46d2-a4e6-cacb1df19ae9" - } - } + "$ref": "#/components/schemas/GsaUpdateDataRule" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", - "value": { - "guid": "e08ad80d-2850-46d2-a4e6-cacb1df19ae9" - } - } + "$ref": "#/components/schemas/GsaUpdateDataRule" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Help File Folder", - "description": "This example demonstrates how to rename an existing help file folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Help File Folder", - "description": "This example demonstrates how to modify the guid of an existing help file folder.", - "value": { - "guid": "e08ad80d-2850-46d2-a4e6-cacb1df19ae9" - } - } + "$ref": "#/components/schemas/GsaUpdateDataRule" } } } @@ -52738,143 +32837,41 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaDataRule" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HelpPage folder.", - "value": { - "message": "Cannot update HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderUpdate", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or data rule name not found" } } }, "delete": { "tags": [ - "Schema - Help Files" + "Schema - Data Rules" ], - "summary": "Delete a Help File Folder.", - "operationId": "DeleteHelpFolder", + "summary": "Delete a data rule.", + "operationId": "DeleteDataRule", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "data-rule-guid", "in": "path", "required": true, "schema": { @@ -52884,228 +32881,208 @@ } ], "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HelpPage folder.", - "value": { - "message": "Cannot delete HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderDeletion", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - } - } - }, "200": { "description": "Ok" }, + "400": { + "description": "Bad request." + }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database or data rule not found." } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:child-folders": { + "/v1alpha/databases": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Databases" ], - "summary": "Get Child Help File Folders", - "operationId": "GetHelpChildFolders", + "summary": "Lists all databases that the user can see.", + "operationId": "GetAllDatabases", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, + "name": "role", + "in": "query", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write", + "powerUser", + "grant", + "admin" + ], + "type": "string" } } ], "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" + "$ref": "#/components/schemas/GsaDatabasesInfo" }, "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, + "databases": [ { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + "key": "MI_Training", + "status": "Ok", + "isReadOnly": false, + "isLocked": false, + "name": "MI Training", + "guid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "versionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "indexInSync": true, + "schemaVersion": "2022.08.18.01" } ] } - }, + } + } + } + } + }, + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Adds a database to the MI server. Only available to users in the System Administrator role.", + "operationId": "AddDatabase", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + } + } + }, + "responses": { + "200": { + "description": "OK.", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] + "$ref": "#/components/schemas/GsaSlimDatabase" } - }, - "text/json": { + } + } + }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + } + } + } + }, + "/v1alpha/databases/{database-key}": { + "get": { + "tags": [ + "Schema - Databases" + ], + "summary": "Returns details for a given database.", + "operationId": "GetDatabase", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "attributenotes", - "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" - }, - { - "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", - "hasFiles": false, - "hasChildFolders": false, - "name": "sciencenotes", - "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" - } - ] + "$ref": "#/components/schemas/GsaDatabase" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": { - "post": { + }, + "delete": { "tags": [ - "Schema - Help Files" + "Schema - Databases" ], - "summary": "Move an existing Help File Folder.", - "operationId": "MoveHelpFolder", + "summary": "Removes the database from the MI server. Only available to users in the System Administrator role.", + "operationId": "RemoveDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "400": { + "description": "Bad request. Returned if database is in the \"Unloading\" state" }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + }, + "patch": { + "tags": [ + "Schema - Databases" + ], + "summary": "Update database details.", + "operationId": "UpdateDatabase", + "parameters": [ { - "name": "folder-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + }, + { + "name": "allow-reload", + "in": "query", + "description": "This must be set to true if any of the following properties are patched:\r\n DatabaseKey, DataSource, UseIntegratedSecurity, SqlUserName, SqlPassword, InitialCatalog, Language, Guid.\r\n The database will reload after the changes have been applied.", + "schema": { + "type": "boolean", + "default": false } } ], @@ -53113,56 +33090,104 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "5d22824b-47c7-4d8b-9a26-cf10947e055a", + "guid": "0a65895d-83ae-4303-9345-c3340333d1b3", + "name": "MI Training (Updated)" + } + }, + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", + "value": { + "author": "Ansys Granta Technical Training (Updated)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "5d22824b-47c7-4d8b-9a26-cf10947e055a", + "guid": "0a65895d-83ae-4303-9345-c3340333d1b3", + "name": "MI Training (Updated)" + } + }, + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", + "value": { + "author": "Ansys Granta Technical Training (Updated)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "5d22824b-47c7-4d8b-9a26-cf10947e055a", + "guid": "0a65895d-83ae-4303-9345-c3340333d1b3", + "name": "MI Training (Updated)" + } + }, + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", + "value": { + "author": "Ansys Granta Technical Training (Updated)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaUpdateDatabase" }, "examples": { "Example 1": { - "summary": "Move Help File Folder", - "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", + "summary": "Update everything in a database", + "description": "This example shows how to update all properties of the MI_Training database.", "value": { - "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "author": "Ansys Granta Technical Training (Updated)", + "company": "ANSYS, Inc. (updated)", + "notes": "MI Training Database for Granta MI v2022R2 and above. This database has been developed to support training classes. Any other use of this database will not be supported by Ansys Granta. (Updated)", + "currencyCode": "PLN", + "versionGuid": "5d22824b-47c7-4d8b-9a26-cf10947e055a", + "guid": "0a65895d-83ae-4303-9345-c3340333d1b3", + "name": "MI Training (Updated)" + } + }, + "Update the author": { + "summary": "This example shows how to update the 'Author' property of the MI_Training database.", + "value": { + "author": "Ansys Granta Technical Training (Updated)" } } } @@ -53171,440 +33196,298 @@ }, "responses": { "200": { - "description": "Ok", + "description": "OK.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaDatabase" } } } }, "400": { - "description": "Bad request", + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases:validate": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Validates whether a database can be added to MI server. Only available to users in the System Administrator role.", + "operationId": "ValidateDatabaseToAdd", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddDatabase" + } + } + } + }, + "responses": { + "200": { + "description": "OK.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HelpPage folder.", - "value": { - "message": "Cannot move HelpPage folder with GUID 'e7dbba58-b963-4d1f-bbf4-c8436d00bf22'.", - "code": "folderMove", - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", - "folderType": "helpPage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } + "$ref": "#/components/schemas/GsaAddDatabaseValidationResult" } } } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Bad request." }, - "404": { - "description": "Database or folder not found" + "403": { + "description": "Forbidden." } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files": { - "get": { + "/v1alpha/databases/{database-key}:upgrade": { + "post": { "tags": [ - "Schema - Help Files" + "Schema - Databases" ], - "summary": "Get Files in a Folder", - "operationId": "GetHelpFiles", + "summary": "Upgrade a database to the latest schema version. Only available to users in the System Administrator role.", + "operationId": "UpgradeDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], "responses": { "200": { - "description": "Ok", + "description": "OK.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - }, - { - "name": "Atomic_volume.html", - "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" - } - ] + "$ref": "#/components/schemas/GsaSlimDatabase" } } } }, + "400": { + "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\" or \"Unknown\" state" + }, + "403": { + "description": "Forbidden." + }, "404": { - "description": "Database or folder not found" + "description": "Database not found." } } - }, + } + }, + "/v1alpha/databases:upgrade-external": { "post": { "tags": [ - "Schema - Help Files" + "Schema - Databases" ], - "summary": "Create a new Help File.", - "operationId": "CreateHelpFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "summary": "Upgrades an external database to the latest schema version. Only available to users in the System Administrator role.", + "operationId": "UpgradeDatabaseNotAddedToMi", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaConnectionDetails" + } } + } + }, + "responses": { + "200": { + "description": "OK." + }, + "400": { + "description": "Bad request. Returned if connecting user is not a db_owner on the database." }, + "403": { + "description": "Forbidden." + } + } + } + }, + "/v1alpha/databases/{database-key}:reload": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Reloads a database. Only available to users in the System Administrator role.", + "operationId": "ReloadDatabase", + "parameters": [ { - "name": "folder-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - } - } - }, - "encoding": { - "file": { - "style": "form" - }, - "description": { - "style": "form" - } - } - } - } - }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "OK.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "258afca2-2522-4fb2-8f09-62e1d831ea92" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "258afca2-2522-4fb2-8f09-62e1d831ea92" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "258afca2-2522-4fb2-8f09-62e1d831ea92" + "$ref": "#/components/schemas/GsaSlimDatabase" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, + "description": "Bad request. Returned if database is in the \"Loading\", \"Unloading\", \"SchemaUpgradeRequired\" or \"SchemaDowngradeRequired\" state" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases/{database-key}:lock": { + "post": { + "tags": [ + "Schema - Databases" + ], + "summary": "Lock database", + "operationId": "LockDatabase", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database to lock", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HelpPage file with name ''.", - "value": { - "message": "Cannot create HelpPage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } + "$ref": "#/components/schemas/GsaDatabase" } } } }, + "400": { + "description": "Bad request." + }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database not found." } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}": { - "get": { + "/v1alpha/databases/{database-key}:unlock": { + "post": { "tags": [ - "Schema - Help Files" + "Schema - Databases" ], - "summary": "Get header information for a help file", - "operationId": "GetHelpFile", + "summary": "Unlock database", + "operationId": "UnlockDatabase", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database to unlock", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabase" + } + } } }, + "400": { + "description": "Bad request." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database not found." + } + } + } + }, + "/v1alpha/databases/{database-key}/discrete-types": { + "get": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Gets all discrete types for a given database.", + "operationId": "GetDiscreteTypes", + "parameters": [ { - "name": "file-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -53612,89 +33495,34 @@ "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", - "description": "Description of Abrasion-rate file.", - "extension": "html", - "dataLength": 5090, - "path": "Help Pages\\html\\attributenotes\\en\\material", - "name": "Abrasion_rate.html", - "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + "$ref": "#/components/schemas/GsaDiscreteTypesInfo" } } } }, + "400": { + "description": "Bad request" + }, "404": { - "description": "Database, folder or file not found" + "description": "Database not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Help Files" + "Schema - Discrete Types" ], - "summary": "Update an existing Help File.", - "operationId": "UpdateHelpFile", + "summary": "Create a new discrete type.", + "operationId": "CreateDiscreteType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -53702,112 +33530,92 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "name": "New File Name" + "isOrdered": true, + "name": "Ordered Discrete Type" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", - "value": { - "description": "New description for help file." - } - }, - "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", "value": { - "guid": "e64a3c81-1382-411a-a93f-bacfa90e8981" + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "name": "New File Name" + "isOrdered": true, + "name": "Ordered Discrete Type" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", - "value": { - "description": "New description for help file." - } - }, - "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", "value": { - "guid": "e64a3c81-1382-411a-a93f-bacfa90e8981" + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "name": "New File Name" + "isOrdered": true, + "name": "Ordered Discrete Type" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", - "value": { - "description": "New description for help file." - } - }, - "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", "value": { - "guid": "e64a3c81-1382-411a-a93f-bacfa90e8981" + "isOrdered": false, + "name": "Unordered Discrete Type" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaCreateDiscreteType" }, "examples": { "Example 1": { - "summary": "Rename Help File", - "description": "This example demonstrates how to rename an existing help file.", + "summary": "Ordered Discrete Type", + "description": "This example demonstrates how to create a new ordered discrete type for the MI_Training database.", "value": { - "name": "New File Name" + "isOrdered": true, + "name": "Ordered Discrete Type" } }, "Example 2": { - "summary": "Modify the description for a Help File", - "description": "This example demonstrates how to change the description for an existing help file.", - "value": { - "description": "New description for help file." - } - }, - "Example 3": { - "summary": "Change guid for Help File", - "description": "This example demonstrates how to modify the guid of an existing help file.", + "summary": "Unordered Discrete Type", + "description": "This example demonstrates how to create a new unordered discrete type for the MI_Training database.", "value": { - "guid": "e64a3c81-1382-411a-a93f-bacfa90e8981" + "isOrdered": false, + "name": "Unordered Discrete Type" } } } @@ -53815,167 +33623,87 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "34675089-79e9-4f58-bdd0-f60b14347381" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "34675089-79e9-4f58-bdd0-f60b14347381" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "34675089-79e9-4f58-bdd0-f60b14347381" + "$ref": "#/components/schemas/GsaSlimDiscreteType" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID 'a136c6f8-b62a-4814-993a-fcac0331e0c4'.", - "code": "fileUpdate", - "fileGuid": "a136c6f8-b62a-4814-993a-fcac0331e0c4", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID 'a136c6f8-b62a-4814-993a-fcac0331e0c4'.", - "code": "fileUpdate", - "fileGuid": "a136c6f8-b62a-4814-993a-fcac0331e0c4", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid FIle name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HelpPage file to ''.", - "value": { - "message": "Cannot update HelpPage file with GUID 'a136c6f8-b62a-4814-993a-fcac0331e0c4'.", - "code": "fileUpdate", - "fileGuid": "a136c6f8-b62a-4814-993a-fcac0331e0c4", - "folderType": "helpPage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}": { + "get": { "tags": [ - "Schema - Help Files" + "Schema - Discrete Types" ], - "summary": "Delete a Help File.", - "operationId": "DeleteHelpFile", + "summary": "Gets a single discrete type.", + "operationId": "GetDiscreteType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "discrete-type-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteType" + } + } + } }, + "404": { + "description": "Database or discrete type not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Discrete Types" + ], + "summary": "Update discrete type.", + "operationId": "UpdateDiscreteType", + "parameters": [ { - "name": "file-guid", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", "in": "path", "required": true, "schema": { @@ -53984,40 +33712,69 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDiscreteType" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDiscreteType" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDiscreteType" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateDiscreteType" + } + } + } + }, "responses": { "200": { - "description": "Ok" + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSlimDiscreteType" + } + } + } + }, + "400": { + "description": "Bad request." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, folder or file not found" + "description": "Database or discrete type not found." } } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:export": { - "get": { + }, + "delete": { "tags": [ - "Schema - Help Files" + "Schema - Discrete Types" ], - "summary": "Get help folder and contents as a zip file", - "operationId": "ExportHelpFolder", + "summary": "Delete discrete type, including all of its discrete values.", + "operationId": "DeleteDiscreteType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "discrete-type-guid", "in": "path", "required": true, "schema": { @@ -54027,54 +33784,68 @@ } ], "responses": { - "200": { - "description": "Ok", + "400": { + "description": "Bad request. Discrete type in use by Attributes.", "content": { - "application/zip": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaDiscreteTypeDeletionException" + }, + "example": { + "message": "Cannot delete discrete type 'MU Durability' (GUID = '00000083-0006-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more attributes.", + "reason": "usage", + "referencedByType": "attribute", + "referencedBy": [ + { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Metals", + "guid": "0000000b-0001-4fff-8fff-dd92ffff0000" + } + ] + } + ] } } - }, - "x-is-file": true + } + }, + "200": { + "description": "OK." + }, + "403": { + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database or discrete type not found." } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:export": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}:usages": { "get": { "tags": [ - "Schema - Help Files" + "Schema - Discrete Types" ], - "summary": "Get help file as a file", - "operationId": "ExportHelpFile", + "summary": "Gets objects that are using this discrete type.", + "operationId": "GetAttributesForType", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "file-guid", + "name": "discrete-type-guid", "in": "path", "required": true, "schema": { @@ -54085,58 +33856,70 @@ ], "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaDiscreteTypeUsage" + }, + "example": { + "attributes": [ + { + "type": "discrete", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "2a77f51b-ac53-4179-bc72-1eb6c378d9ef" + }, + "name": "Reinforcement architecture", + "guid": "b172b9b3-228c-4784-9eaa-66349442f930" + } + ], + "tabularColumns": [ + { + "tabularAttribute": { + "type": "link", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "name": "Lay-up sequence details", + "guid": "af6fc0e6-dfbb-4f51-aad3-79419cd5ee92" + }, + "columns": [ + { + "name": "Ply/layer architecture", + "guid": "d0f981f1-9934-4518-af7e-f2a67573f0b0" + } + ] + } + ] } } - }, - "x-is-file": true + } + }, + "400": { + "description": "Bad request" }, "404": { - "description": "Database, folder or file not found" + "description": "Database or discrete type not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": { + "/v1alpha/databases/{database-key}/discrete-types:query": { "post": { "tags": [ - "Schema - Help Files" + "Schema - Discrete Types" ], - "summary": "Move an existing Help File.", - "operationId": "MoveHelpFile", + "summary": "Gets discrete types for a given database, populates the requested properties.", + "operationId": "QueryDiscreteTypes", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -54144,421 +33927,338 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Fetch all discrete types with custom properties", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "properties": { + "discreteValues": { + "name": true, + "guid": true + }, + "isOrdered": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", + "value": { + "properties": { + "discreteValues": { + "name": true + }, + "name": true + } + } + }, + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Surface Finish" + ] + } + } + }, + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" + ] + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Fetch all discrete types with custom properties", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "properties": { + "discreteValues": { + "name": true, + "guid": true + }, + "isOrdered": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", + "value": { + "properties": { + "discreteValues": { + "name": true + }, + "name": true + } + } + }, + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Surface Finish" + ] + } + } + }, + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" + ] + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Fetch all discrete types with custom properties", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "properties": { + "discreteValues": { + "name": true, + "guid": true + }, + "isOrdered": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", + "value": { + "properties": { + "discreteValues": { + "name": true + }, + "name": true + } + } + }, + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Surface Finish" + ] + } + } + }, + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" + ] + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesRequest" }, "examples": { "Example 1": { - "summary": "Move Help File", - "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "summary": "Fetch all discrete types with custom properties", "value": { - "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + "properties": { + "discreteValues": { + "name": true, + "guid": true + }, + "isOrdered": true, + "name": true, + "guid": true + } } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ce1b8e2-9b00-405d-bdb4-2d59c809cd2f" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ce1b8e2-9b00-405d-bdb4-2d59c809cd2f" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" - }, - "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "5ce1b8e2-9b00-405d-bdb4-2d59c809cd2f" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID '7d5e21c1-181f-45bb-98b1-c42aefbae431'.", - "code": "fileMove", - "fileGuid": "7d5e21c1-181f-45bb-98b1-c42aefbae431", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa' does not exist in database MI_Training.", - "folderGuid": "18dc26a1-71af-4b92-a9f6-4006ad3149aa", - "folderType": "helpPage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } - ] + "Example 2": { + "summary": "Fetch all discrete types with name and discrete value names", + "value": { + "properties": { + "discreteValues": { + "name": true + }, + "name": true } } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID '7d5e21c1-181f-45bb-98b1-c42aefbae431'.", - "code": "fileMove", - "fileGuid": "7d5e21c1-181f-45bb-98b1-c42aefbae431", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa' does not exist in database MI_Training.", - "folderGuid": "18dc26a1-71af-4b92-a9f6-4006ad3149aa", - "folderType": "helpPage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } + "Example 3": { + "summary": "Fetch discrete type with name \"Surface Finish\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "Surface Finish" ] } } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa', but there is no HelpPage folder with that GUID.", - "value": { - "message": "Cannot move HelpPage file with GUID '7d5e21c1-181f-45bb-98b1-c42aefbae431'.", - "code": "fileMove", - "fileGuid": "7d5e21c1-181f-45bb-98b1-c42aefbae431", - "folderType": "helpPage", - "errors": [ - { - "message": "A HelpPage folder with GUID '18dc26a1-71af-4b92-a9f6-4006ad3149aa' does not exist in database MI_Training.", - "folderGuid": "18dc26a1-71af-4b92-a9f6-4006ad3149aa", - "folderType": "helpPage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } + "Example 4": { + "summary": "Fetch discrete types with matching GUID", + "description": "This example demonstrates how to find discrete types by GUID in database 'MI Training'.", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "guid": [ + "2ba638a6-b807-4480-a388-f1b5637489b2", + "00000083-0006-4fff-8fff-0000ffff0000" ] } } } } } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, folder or file not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:descendants": { - "get": { - "tags": [ - "Schema - Help Files" - ], - "summary": "Returns file information for all descendants of a Help File folder.", - "operationId": "GetHelpFileDescendants", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } - ], + }, "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaQueryDiscreteTypesInfo" } } } }, + "400": { + "description": "Bad request" + }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/help-folders:validate": { - "post": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values": { + "get": { "tags": [ - "Schema - Help Files" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Verify that help pages exist for all attributes and parameters that have help paths defined.\r\nReturns schema entity and help path if the help path does not match an existing help page.", - "operationId": "ValidateHelpPaths", + "summary": "Gets all discrete values for a given discreteType, returned in order.", + "operationId": "GetDiscreteValues", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaHelpPathsValidationResponse" - } - } + "type": "string" } }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders": { - "get": { - "tags": [ - "Schema - Home Pages" - ], - "summary": "Get All Home Page Folders", - "operationId": "GetHomePageFolders", - "parameters": [ { - "name": "database-key", + "name": "discrete-type-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "67d570b9-11ab-467b-b9d3-ac4dc5667822" - } - ] - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "67d570b9-11ab-467b-b9d3-ac4dc5667822" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFoldersInfo" - }, - "example": { - "folders": [ - { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - }, - { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "67d570b9-11ab-467b-b9d3-ac4dc5667822" - } - ] + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" } } } }, "404": { - "description": "Database not found" + "description": "Database or discrete type not found" } } }, "post": { "tags": [ - "Schema - Home Pages" - ], - "summary": "Create a new Home Page Folder.", - "operationId": "CreateHomePageFolder", + "Schema - DiscreteTypes - DiscreteValues" + ], + "summary": "Create new discrete value. It will be added at the end.", + "operationId": "CreateDiscreteValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -54566,60 +34266,88 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "name": "New Discrete Value 1" + } + }, + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "value": { + "name": "New Discrete Value 2", + "guid": "49c63945-3aab-42fe-9896-b53afa8e3ba5" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "name": "New Discrete Value 1" + } + }, + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "value": { + "name": "New Discrete Value 2", + "guid": "49c63945-3aab-42fe-9896-b53afa8e3ba5" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "name": "New Discrete Value 1" + } + }, + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "value": { + "name": "New Discrete Value 2", + "guid": "49c63945-3aab-42fe-9896-b53afa8e3ba5" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateFolder" + "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" }, "examples": { "Example 1": { - "summary": "Home Page Folder", - "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", + "summary": "Discrete Value", + "description": "This example demonstrates how to create a new discrete value.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "name": "New Folder" + "name": "New Discrete Value 1" + } + }, + "Example 2": { + "summary": "Discrete Value with Guid", + "description": "This example demonstrates how to create a new discrete value with a specified guid value.", + "value": { + "name": "New Discrete Value 2", + "guid": "49c63945-3aab-42fe-9896-b53afa8e3ba5" } } } @@ -54630,237 +34358,123 @@ "201": { "description": "Created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid Folder name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage folder with name ''.", - "value": { - "message": "Cannot create HomePage folder ''.", - "code": "folderCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - }, - "Example 2": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateFolder: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or discrete type not found" } } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders:root-folder": { - "get": { + }, + "put": { "tags": [ - "Schema - Home Pages" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Get Root Home Page Folder", - "operationId": "GetHomePageRootFolder", + "summary": "Replace the whole discrete value collection for a given discrete type.\r\nThis will result in adding, modifying, deleting and reordering discrete values. If any of those operations fail, the whole operation fails.", + "operationId": "ReplaceDiscreteValues", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesReplaceDiscreteValuesInfo" + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Home Pages", - "guid": "c13eb185-2558-4b4a-8395-33c031663925" + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" } } } }, + "400": { + "description": "Bad Request. e.g. would delete a discrete value that is in use." + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database not found" + "description": "Database or discrete type not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values/{discrete-value-guid}": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Get Home Page Folder", - "operationId": "GetHomePageFolder", + "summary": "Gets specific discrete value for a given discreteType within a given database.", + "operationId": "GetDiscreteValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "discrete-value-guid", "in": "path", "required": true, "schema": { @@ -54871,71 +34485,46 @@ ], "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "a2b234ea-3d70-4a7d-996f-cffd7cdbc0c0" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "a2b234ea-3d70-4a7d-996f-cffd7cdbc0c0" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "a2b234ea-3d70-4a7d-996f-cffd7cdbc0c0" + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" } } } }, "404": { - "description": "Database or folder not found" + "description": "Database, discrete type or discrete value not found" } } }, "patch": { "tags": [ - "Schema - Home Pages" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Update an existing Home Page Folder.", - "operationId": "UpdateHomePageFolder", + "summary": "Update discrete value.", + "operationId": "UpdateDiscreteValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "discrete-value-guid", "in": "path", "required": true, "schema": { @@ -54948,347 +34537,123 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", - "value": { - "guid": "319fa3d7-f726-4453-af04-ba26dbfe843e" - } - } + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", - "value": { - "guid": "319fa3d7-f726-4453-af04-ba26dbfe843e" - } - } + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", - "value": { - "guid": "319fa3d7-f726-4453-af04-ba26dbfe843e" - } - } + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFolder" - }, - "examples": { - "Example 1": { - "summary": "Rename Home Page Folder", - "description": "This example demonstrates how to rename an existing home page folder.", - "value": { - "name": "New Folder Name" - } - }, - "Example 2": { - "summary": "Change guid for Home Page Folder", - "description": "This example demonstrates how to modify the guid of an existing home page folder.", - "value": { - "guid": "319fa3d7-f726-4453-af04-ba26dbfe843e" - } - } + "$ref": "#/components/schemas/GsaDiscreteValuesUpdateDiscreteValue" } } } }, "responses": { "200": { - "description": "Ok", + "description": "OK.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolder" - }, - "example": { - "hasFiles": false, - "hasChildFolders": false, - "name": "Exporters", - "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValue" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Cannot update the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the root HomePage folder.", - "value": { - "message": "Cannot update HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderUpdate", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot update the root folder.", - "reason": "updateRoot" - } - ] - } - } - } - } - } + "description": "Bad request." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database not found" + "description": "Database, discrete type or discrete value not found." } } }, "delete": { "tags": [ - "Schema - Home Pages" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Delete a Home Page Folder.", - "operationId": "DeleteHomePageFolder", + "summary": "Delete a single discrete value. It must not be used by any data, or the operation will fail.", + "operationId": "DeleteDiscreteValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discrete-type-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "folder-guid", + "name": "discrete-value-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Cannot delete the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to delete the root HomePage folder.", - "value": { - "message": "Cannot delete HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderDeletion", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot delete the root folder.", - "reason": "root" - } - ] - } - } + } + ], + "responses": { + "400": { + "description": "Bad request. Discrete value in use.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValueAggregateException" } } } }, "200": { - "description": "Ok" + "description": "OK." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database or folder not found" + "description": "Database, discrete type or discrete value not found." } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:child-folders": { + "/v1alpha/databases/{database-key}/discrete-types/{discrete-type-guid}/discrete-values:find-unused": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - DiscreteTypes - DiscreteValues" ], - "summary": "Get Child Home Page Folders", - "operationId": "GetHomePageChildFolders", + "summary": "Find discrete values that are not in use by any data", + "operationId": "FindUnusedDiscreteValues", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "folder-guid", + "name": "discrete-type-guid", "in": "path", "required": true, "schema": { @@ -55297,6 +34662,43 @@ } } ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDiscreteValuesDiscreteValuesInfo" + } + } + } + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Database or discrete type not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get All Exporter Folders", + "operationId": "GetExportersFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "Ok", @@ -55308,11 +34710,23 @@ "example": { "folders": [ { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "04ea5cdd-5ad2-4692-a7cf-e6b58cc6d4c8" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + }, + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } ] } @@ -55324,11 +34738,23 @@ "example": { "folders": [ { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "04ea5cdd-5ad2-4692-a7cf-e6b58cc6d4c8" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + }, + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } ] } @@ -55340,11 +34766,23 @@ "example": { "folders": [ { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "hasFiles": false, - "hasChildFolders": false, - "name": "images", - "guid": "04ea5cdd-5ad2-4692-a7cf-e6b58cc6d4c8" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + }, + { + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "MI_Training", + "guid": "19cc65a2-f8bf-4989-9859-e883756290de" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" } ] } @@ -55352,37 +34790,23 @@ } }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": { + }, "post": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Move an existing Home Page Folder.", - "operationId": "MoveHomePageFolder", + "summary": "Create a new Exporters Folder.", + "operationId": "CreateExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -55390,56 +34814,60 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFolder" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page Folder", - "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "summary": "Exporter Folder", + "description": "This example demonstrates how to create a new exporter folder under the root 'Exporters' folder.", "value": { - "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "New Folder" } } } @@ -55447,16 +34875,14 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GsaFolder" }, "example": { - "hasFiles": false, - "hasChildFolders": false, "name": "Exporters", "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } @@ -55466,8 +34892,6 @@ "$ref": "#/components/schemas/GsaFolder" }, "example": { - "hasFiles": false, - "hasChildFolders": false, "name": "Exporters", "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } @@ -55477,8 +34901,6 @@ "$ref": "#/components/schemas/GsaFolder" }, "example": { - "hasFiles": false, - "hasChildFolders": false, "name": "Exporters", "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } @@ -55486,114 +34908,31 @@ } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFolderMoveException" - }, - "examples": { - "Example 1": { - "summary": "Cannot move the root folder", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move the root HomePage folder.", - "value": { - "message": "Cannot move HomePage folder with GUID 'c13eb185-2558-4b4a-8395-33c031663925'.", - "code": "folderMove", - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "folderType": "homePage", - "errors": [ - { - "message": "You cannot move the root folder.", - "reason": "root" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files": { + "/v1alpha/databases/{database-key}/exporters:root-folder": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Get the Home Page Files in a Folder", - "operationId": "GetHomePageFiles", + "summary": "Get Root Exporters Folder", + "operationId": "GetExportersRootFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -55603,267 +34942,53 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "1ceb3fbe-3ea4-4704-af2f-5d3315efb8c8" - }, - { - "name": "home-page-2.html", - "guid": "ab053431-2a29-4365-9bfc-f0977ac2d7a5" - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "1ceb3fbe-3ea4-4704-af2f-5d3315efb8c8" - }, - { - "name": "home-page-2.html", - "guid": "ab053431-2a29-4365-9bfc-f0977ac2d7a5" - } - ] - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFilesInfo" - }, - "example": { - "files": [ - { - "name": "home-page-1.html", - "guid": "1ceb3fbe-3ea4-4704-af2f-5d3315efb8c8" - }, - { - "name": "home-page-2.html", - "guid": "ab053431-2a29-4365-9bfc-f0977ac2d7a5" - } - ] - } - } - } - }, - "404": { - "description": "Database or folder not found" - } - } - }, - "post": { - "tags": [ - "Schema - Home Pages" - ], - "summary": "Create a new Home Page File.", - "operationId": "CreateHomePageFile", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "description": { - "type": "string" - } - } - }, - "encoding": { - "file": { - "style": "form" - }, - "description": { - "style": "form" - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "95106a29-8b8c-4438-8de2-66990be4eaa1" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "95106a29-8b8c-4438-8de2-66990be4eaa1" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "95106a29-8b8c-4438-8de2-66990be4eaa1" - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", - "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", - "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileCreationException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a HomePage file with name ''.", - "value": { - "message": "Cannot create HomePage file ''.", - "code": "fileCreation", - "name": "", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or folder not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Get the header information for a Home Page File", - "operationId": "GetHomePageFile", + "summary": "Get Exporters Folder", + "operationId": "GetExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -55874,15 +34999,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { @@ -55891,82 +35007,58 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "2839787c-2d3b-4979-9eb3-47823815b934" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "2839787c-2d3b-4979-9eb3-47823815b934" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", - "description": "Description of home page file.", - "extension": "html", - "dataLength": 12895, - "path": "HomePages", - "name": "home-page.html", - "guid": "2839787c-2d3b-4979-9eb3-47823815b934" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" } } } }, "404": { - "description": "Database, folder or file not found" + "description": "Database or folder not found" } } }, "patch": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Update an existing Home Page File.", - "operationId": "UpdateHomePageFile", + "summary": "Update an existing Exporters Folder.", + "operationId": "UpdateExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "file-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -55979,112 +35071,84 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "name": "New File Name" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "guid": "8ce40c2e-71f6-4285-b047-e3c3519f8484" + "guid": "41a0bbf8-5d96-4770-b0e5-5b541ba7623d" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "name": "New File Name" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "guid": "8ce40c2e-71f6-4285-b047-e3c3519f8484" + "guid": "41a0bbf8-5d96-4770-b0e5-5b541ba7623d" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "name": "New File Name" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "guid": "8ce40c2e-71f6-4285-b047-e3c3519f8484" + "guid": "41a0bbf8-5d96-4770-b0e5-5b541ba7623d" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateFile" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Rename Home Page File", - "description": "This example demonstrates how to rename an existing home page file.", + "summary": "Rename Exporter Folder", + "description": "This example demonstrates how to rename an existing Exporter folder.", "value": { - "name": "New File Name" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Modify the description for a Home Page File", - "description": "This example demonstrates how to change the description for an existing home page file.", - "value": { - "description": "New description for home page file." - } - }, - "Example 3": { - "summary": "Change guid for Home Page File", - "description": "This example demonstrates how to modify the guid of an existing home page file.", + "summary": "Change guid for Exporter Folder", + "description": "This example demonstrates how to modify the guid of an existing Exporter folder.", "value": { - "guid": "8ce40c2e-71f6-4285-b047-e3c3519f8484" + "guid": "41a0bbf8-5d96-4770-b0e5-5b541ba7623d" } } } @@ -56097,149 +35161,57 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "bbccf960-86e9-4a43-97da-cd15e5c4743d" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "bbccf960-86e9-4a43-97da-cd15e5c4743d" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "bbccf960-86e9-4a43-97da-cd15e5c4743d" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "400": { - "description": "Bad request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6'.", - "code": "fileUpdate", - "fileGuid": "693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6'.", - "code": "fileUpdate", - "fileGuid": "693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaFileUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Invalid File name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to rename a HomePage file to ''.", - "value": { - "message": "Cannot update HomePage file with GUID '693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6'.", - "code": "fileUpdate", - "fileGuid": "693fbe15-1f3b-482a-89bf-8e0a3f6a8aa6", - "folderType": "homePage", - "errors": [ - { - "message": "'' is not a valid file name. You cannot use directory separators or special characters in file or folder names.", - "name": "", - "reason": "fileName" - } - ] - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database or folder not found" } } }, "delete": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Delete a Home Page File.", - "operationId": "DeleteHomePageFile", + "summary": "Delete an Exporter Folder.", + "operationId": "DeleteExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -56250,15 +35222,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "responses": { @@ -56269,28 +35232,25 @@ "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:export": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}:child-folders": { "get": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Get Home Page folder and contents as a zip file", - "operationId": "ExportHomePageFolder", + "summary": "Get Child Exporters Folders", + "operationId": "GetExportersChildFolders", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -56307,14 +35267,64 @@ "200": { "description": "Ok", "content": { - "application/zip": { + "text/plain": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Abaqus", + "guid": "41aba877-8fe0-4295-bddb-6f8b270a40ff" + }, + { + "parentGuid": "19cc65a2-f8bf-4989-9859-e883756290de", + "name": "Ansys Workbench", + "guid": "92be9c31-7aff-4d96-8069-983390284391" + } + ] } } - }, - "x-is-file": true + } }, "404": { "description": "Database or folder not found" @@ -56322,41 +35332,20 @@ } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": { - "get": { + "/v1alpha/databases/{database-key}/exporters:re-fetch": { + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Get Home Page File as a file", - "operationId": "ExportHomePageFile", + "summary": "Re-fetch the Exporter Files.", + "operationId": "RefetchExporters", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "folder-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "file-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -56364,38 +35353,49 @@ "200": { "description": "Ok", "content": { - "application/octet-stream": { + "text/plain": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/GsaExporterRefetchInfo" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaExporterRefetchInfo" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaExporterRefetchInfo" } } - }, - "x-is-file": true + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database, folder or file not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:move": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}:move": { "post": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Move an existing Home Page File.", - "operationId": "MoveHomePageFile", + "summary": "Move an existing Exporter Folder.", + "operationId": "MoveExportersFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -56406,71 +35406,62 @@ "type": "string", "format": "uuid" } - }, - { - "name": "file-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaMoveFile" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Move Home Page File", - "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", + "summary": "Move Exporter Folder", + "description": "This example demonstrates how to move an existing exporter folder to be under the root 'Exporters' folder.", "value": { - "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" + "parentGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } @@ -56483,157 +35474,146 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "2a854dce-c5ae-4f59-b943-93ac1b6e5af2" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "2a854dce-c5ae-4f59-b943-93ac1b6e5af2" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeader" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", - "description": "Description of exporter file.", - "extension": "exp", - "dataLength": 12895, - "path": "Exporters", - "name": "exporter-1.exp", - "guid": "2a854dce-c5ae-4f59-b943-93ac1b6e5af2" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "400": { - "description": "Bad request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get the Exporter Files in a Folder", + "operationId": "GetExportersFiles", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" + "$ref": "#/components/schemas/GsaFilesInfo" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID '5a8dd35c-0512-4804-8fd9-cfbb71072814'.", - "code": "fileMove", - "fileGuid": "5a8dd35c-0512-4804-8fd9-cfbb71072814", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6' does not exist in database MI_Training.", - "folderGuid": "048916ce-79f3-4f8f-b084-ec92b3cb20f6", - "folderType": "homePage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } - ] + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "c3947a14-261c-4a53-b6c9-1c3f1857eb31" + }, + { + "name": "no-transform.xslt", + "guid": "bdcdf6dc-fcae-46ed-aaeb-67367f3cbd87" } - } + ] } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" + "$ref": "#/components/schemas/GsaFilesInfo" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID '5a8dd35c-0512-4804-8fd9-cfbb71072814'.", - "code": "fileMove", - "fileGuid": "5a8dd35c-0512-4804-8fd9-cfbb71072814", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6' does not exist in database MI_Training.", - "folderGuid": "048916ce-79f3-4f8f-b084-ec92b3cb20f6", - "folderType": "homePage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } - ] + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "c3947a14-261c-4a53-b6c9-1c3f1857eb31" + }, + { + "name": "no-transform.xslt", + "guid": "bdcdf6dc-fcae-46ed-aaeb-67367f3cbd87" } - } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileMoveException" + "$ref": "#/components/schemas/GsaFilesInfo" }, - "examples": { - "Example 1": { - "summary": "New parent folder not found.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to move an existing file to a folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6', but there is no HomePage folder with that GUID.", - "value": { - "message": "Cannot move HomePage file with GUID '5a8dd35c-0512-4804-8fd9-cfbb71072814'.", - "code": "fileMove", - "fileGuid": "5a8dd35c-0512-4804-8fd9-cfbb71072814", - "folderType": "homePage", - "errors": [ - { - "message": "A HomePage folder with GUID '048916ce-79f3-4f8f-b084-ec92b3cb20f6' does not exist in database MI_Training.", - "folderGuid": "048916ce-79f3-4f8f-b084-ec92b3cb20f6", - "folderType": "homePage", - "databaseKey": "MI_Training", - "reason": "noSuchNewParent" - } - ] + "example": { + "files": [ + { + "name": "exporter-1.exp", + "guid": "c3947a14-261c-4a53-b6c9-1c3f1857eb31" + }, + { + "name": "no-transform.xslt", + "guid": "bdcdf6dc-fcae-46ed-aaeb-67367f3cbd87" } - } + ] } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database, folder or file not found" + "description": "Database or folder not found" } } - } - }, - "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:descendants": { - "get": { + }, + "post": { "tags": [ - "Schema - Home Pages" + "Schema - Exporters" ], - "summary": "Returns file information for all descendants of a Home Page folder.", - "operationId": "GetHomePageDescendants", + "summary": "Create a new Exporter File.", + "operationId": "CreateExportersFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -56645,265 +35625,207 @@ "format": "uuid" } } - ], + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" + } + } + }, + "encoding": { + "file": { + "style": "form" + }, + "description": { + "style": "form" + } + } + } + } + }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "fbdc2dcc-7688-4329-a29d-f225aac80a32" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "fbdc2dcc-7688-4329-a29d-f225aac80a32" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaFileHeaderInfo" + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "fbdc2dcc-7688-4329-a29d-f225aac80a32" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": { + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}": { "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Exporters" ], - "summary": "Get all sections for a layout", - "operationId": "GetLayoutSections", + "summary": "Get the header information for an Exporter File", + "operationId": "GetExporterFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "828f02d6-c2c6-4158-b8a5-335d48f8c5a0" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSectionsInfo" + "$ref": "#/components/schemas/GsaFileHeader" }, - "examples": { - "Example 1": { - "summary": "Get 'slim' layout sections", - "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "layoutSections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ] - } - }, - "Example 2": { - "summary": "Get 'full' layout sections", - "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to true.", - "value": { - "layoutSections": [ - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "17f495f6-9dc7-48bd-8f2a-b76ff8a41479", - "displayNames": {}, - "name": "Price", - "guid": "3ec92220-2a27-4f20-b5d5-d576ac67f41b" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "66a9029f-5701-46a4-896a-7f849d415905", - "displayNames": {}, - "name": "Density", - "guid": "adaa3ad9-2ed9-411e-b969-b7158ec36524" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "6bca173f-c6f1-4cda-a423-ff527b68aeb3", - "displayNames": {}, - "name": "Young's modulus", - "guid": "ed7f18dd-fce4-47fd-b125-d28ecc25a3a7" - }, - { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "5dc8079c-fd2b-4437-86a9-01e860e6fd37", - "displayNames": {}, - "name": "Tensile strength", - "guid": "e4a6695d-079f-4242-a09a-fdc6a37152c2" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "200fef74-5fa9-4024-b6cf-c0c4acd6bad3", - "displayNames": {}, - "name": "Shape factor", - "guid": "4d5a2260-9f64-4712-a0e6-a8e1e2c7eb75" - } - ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ] - } - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "828f02d6-c2c6-4158-b8a5-335d48f8c5a0" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "828f02d6-c2c6-4158-b8a5-335d48f8c5a0" } } } }, "404": { - "description": "Database, table or layout not found" + "description": "Database, folder or file not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Layout Sections" + "Schema - Exporters" ], - "summary": "Create a new layout section.", - "operationId": "CreateSection", + "summary": "Update an existing Exporter File.", + "operationId": "UpdateExportersFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { @@ -56916,447 +35838,112 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Additional Properties" - } - }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "name": "Additional Properties (Guid)", - "guid": "fb4d3fcd-40ab-4225-8363-5cf21f2ac7e9" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "name": "Additional Properties" + "name": "New File Name" } }, "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "name": "Additional Properties (Guid)", - "guid": "fb4d3fcd-40ab-4225-8363-5cf21f2ac7e9" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" - }, - "examples": { - "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "name": "Additional Properties" + "description": "New description for Exporter file." } }, - "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", "value": { - "name": "Additional Properties (Guid)", - "guid": "fb4d3fcd-40ab-4225-8363-5cf21f2ac7e9" + "guid": "86f4e965-fab6-47ea-9bcb-fc50238ca723" } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Layout Section", - "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "name": "Additional Properties" + "name": "New File Name" } }, "Example 2": { - "summary": "Layout Section with Guid", - "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", - "value": { - "name": "Additional Properties (Guid)", - "guid": "fb4d3fcd-40ab-4225-8363-5cf21f2ac7e9" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSlimLayoutSection" - }, - "example": { - "sectionDetailType": "slim", - "displayNames": {}, - "name": "Additional Properties", - "guid": "cf871b67-8ee9-434c-ba57-745c630c4316" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or layout not found" - } - } - }, - "put": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Reorder the list of layout sections for a layout.", - "operationId": "ReorderSections", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" - }, - "examples": { - "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "description": "New description for Exporter file." } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" - }, - "examples": { - "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + }, + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "value": { + "guid": "86f4e965-fab6-47ea-9bcb-fc50238ca723" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", + "value": { + "description": "New description for Exporter file." + } + }, + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "value": { + "guid": "86f4e965-fab6-47ea-9bcb-fc50238ca723" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaReorderSectionsInfo" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Reorder Layout Sections", - "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Exporter File", + "description": "This example demonstrates how to rename an existing Exporter file.", "value": { - "layoutSections": [ - { - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "name": "New File Name" + } + }, + "Example 2": { + "summary": "Modify the description for an Exporter File", + "description": "This example demonstrates how to change the description for an existing Exporter file.", + "value": { + "description": "New description for Exporter file." + } + }, + "Example 3": { + "summary": "Change guid for Exporter File", + "description": "This example demonstrates how to modify the guid of an existing Exporter file.", + "value": { + "guid": "86f4e965-fab6-47ea-9bcb-fc50238ca723" } } } @@ -57367,193 +35954,292 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "74725e05-f4b2-4c7b-a692-611296ea9d66" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSectionsInfo" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "layoutSections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Electrical Properties English Display Name", - "fr": "Electrical Properties French Display Name" - }, - "name": "Electrical Properties", - "guid": "07124fac-3100-444f-ad5b-385decd9539f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Composition Overview English Display Name", - "fr": "Composition Overview French Display Name" - }, - "name": "Composition Overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Composition detail (metals, ceramics and glasses) English Display Name", - "fr": "Composition detail (metals, ceramics and glasses) French Display Name" - }, - "name": "Composition detail (metals, ceramics and glasses)", - "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Restricted substances English Display Name", - "fr": "Restricted substances French Display Name" - }, - "name": "Restricted substances", - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Further Information English Display Name", - "fr": "Further Information French Display Name" - }, - "name": "Further Information", - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Restricted substances English Display Name", - "fr": "Restricted substances French Display Name" - }, - "name": "Restricted substances", - "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Notes English Display Name", - "fr": "Notes French Display Name" - }, - "name": "Notes", - "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material recycling: energy, CO2 and recycle fraction English Display Name", - "fr": "Material recycling: energy, CO2 and recycle fraction French Display Name" - }, - "name": "Material recycling: energy, CO2 and recycle fraction", - "guid": "b175f578-cf61-4642-9b98-eda48578db1e" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material processing: CO2 footprint English Display Name", - "fr": "Material processing: CO2 footprint French Display Name" - }, - "name": "Material processing: CO2 footprint", - "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Material processing: energy English Display Name", - "fr": "Material processing: energy French Display Name" - }, - "name": "Material processing: energy", - "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Eco-indicators for principal component English Display Name", - "fr": "Eco-indicators for principal component French Display Name" - }, - "name": "Eco-indicators for principal component", - "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Primary material production: energy, CO2 and water English Display Name", - "fr": "Primary material production: energy, CO2 and water French Display Name" - }, - "name": "Primary material production: energy, CO2 and water", - "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Geo-economic data for principal component English Display Name", - "fr": "Geo-economic data for principal component French Display Name" - }, - "name": "Geo-economic data for principal component", - "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Durability: fluids and sunlight English Display Name", - "fr": "Durability: fluids and sunlight French Display Name" - }, - "name": "Durability: fluids and sunlight", - "guid": "83ba3aad-cb2f-49df-89e5-091017087563" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Durability: flammability English Display Name", - "fr": "Durability: flammability French Display Name" - }, - "name": "Durability: flammability", - "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Optical properties English Display Name", - "fr": "Optical properties French Display Name" - }, - "name": "Optical properties", - "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Thermal properties English Display Name", - "fr": "Thermal properties French Display Name" - }, - "name": "Thermal properties", - "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Bio-data English Display Name", - "fr": "Bio-data French Display Name" - }, - "name": "Bio-data", - "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" - } - ] + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "74725e05-f4b2-4c7b-a692-611296ea9d66" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "74725e05-f4b2-4c7b-a692-611296ea9d66" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, folder or file not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Delete an Exporter File.", + "operationId": "DeleteExportersFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:export": { + "get": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Get Exporter File as a file", + "operationId": "ExportExportersFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/exporters/{folder-guid}/files/{file-guid}:move": { + "post": { + "tags": [ + "Schema - Exporters" + ], + "summary": "Move an existing Exporter File.", + "operationId": "MoveExportersFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "value": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "value": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "value": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Exporter File", + "description": "This example demonstrates how to move an existing Exporter file to be under the root 'Exporters' folder.", + "value": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "c40f873f-8d9f-4dfd-9082-3ac1f3d2a9a7" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "c40f873f-8d9f-4dfd-9082-3ac1f3d2a9a7" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "c40f873f-8d9f-4dfd-9082-3ac1f3d2a9a7" } } } @@ -57565,66 +36251,36 @@ "description": "Forbidden" }, "404": { - "description": "Database, table, layout or layout section not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions": { "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Expressions" ], - "summary": "Get a layout section with a specified guid for a given layout.", - "operationId": "GetLayoutSection", + "summary": "Get all expressions for table", + "operationId": "GetExpressions", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, { "name": "mode", "in": "query", @@ -57656,139 +36312,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSection" + "$ref": "#/components/schemas/GsaExpressionsInfo" }, "examples": { "Example 1": { - "summary": "Get 'slim' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "detailType": "slim", - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "9cc2f71a-51d0-4e4b-8df0-038ba8447cf8" - } - }, - "Example 2": { - "summary": "Get 'full' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", + "summary": "Get all expressions", + "description": "This example demonstrates the response to getting all expressions from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", "value": { - "detailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "22e22d63-4713-402c-ab12-9287ff6b2696", - "displayNames": {}, - "name": "Form", - "guid": "8907021a-8c05-46bb-a7ef-1f6c3bcd5561" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [ - { - "itemType": "attribute", - "attributeType": "longText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "3c40645c-bd96-42f2-b9d1-5950eaf89ca7", - "displayNames": {}, - "name": "Sources", - "guid": "856ddddd-004b-48d8-aede-53a5fedead33" - }, - { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "b8ba0668-cdce-4dbf-b20a-8b6b61e8dc2a", - "displayNames": {}, - "name": "Notes", - "guid": "b473347a-a1f3-4624-9ed1-03be92e24fb3" - } - ], - "underlyingEntityGuid": "c984b7fd-b5c1-4000-a5b9-2a310291e7ad", - "displayNames": {}, - "name": "Chemical resistance", - "guid": "729b3c60-4d17-450b-82f3-ed9ed37a80af" - }, - { - "itemType": "link", - "linkType": "recordLink", - "targetDatabase": "458fbf6c-4a07-451c-998b-892b33228d92", - "targetDatabaseVersion": "32cfe915-5abb-4dcc-8379-ff88b18624a4", - "targetTable": "20c2162b-a837-4e9f-af6d-afb9f5fc4c3a", - "forwards": true, - "underlyingEntityGuid": "7176c611-d14e-4a28-a38c-572079c4d660", - "displayNames": {}, - "name": "Material Pedigree", - "guid": "dd47e023-89d0-4e96-9044-7c988e2c96d6" - }, - { - "itemType": "attribute", - "attributeType": "link", - "required": false, - "readOnly": false, - "metaAttributes": [], - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "tabularColumnGuid": "49faf78d-bffb-4441-9a89-ba58c94e0f69", - "name": "Offset Yield Stress", - "guid": "e2023d37-6470-4008-bcf8-c4ada25500ee" - }, - { - "columnType": "localShortText", - "tabularColumnGuid": "064c6bd1-ddaf-45ef-8a91-56f64619cfa2", - "name": "Young's Modulus Notes", - "guid": "1d23bd34-944a-424a-9764-c5b36099fece" - } - ], - "underlyingEntityGuid": "c33ad946-2a31-4639-9953-b3a722e56ba1", - "displayNames": {}, - "name": "Reference Characteristics", - "guid": "b200f38e-e7f2-40c1-8b58-d7e1cccbce45" - }, + "expressions": [ { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "458fbf6c-4a07-451c-998b-892b33228d92", - "targetDatabaseVersion": "32cfe915-5abb-4dcc-8379-ff88b18624a4", - "targetTable": "2ed1a548-5401-4f52-81bd-fc5d678270b2", - "forwards": true, - "nextLink": { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "458fbf6c-4a07-451c-998b-892b33228d92", - "targetDatabaseVersion": "32cfe915-5abb-4dcc-8379-ff88b18624a4", - "targetTable": "f6597e43-a1b8-4182-a1cf-88c905ffcee8", - "forwards": false, - "underlyingEntityGuid": "76a5d223-4d45-4356-bdd4-7e979ebb952b", - "displayNames": {}, - "name": "Pedigree information", - "guid": "bbb64280-d4d0-4110-ad47-786982463e65" - }, - "underlyingEntityGuid": "22b5426c-e247-49da-9567-d8ac8d52dd85", - "displayNames": {}, - "name": "To Pedigree from Producers", - "guid": "92699f3d-4fd4-4ed3-bf91-b9d51a4450a9" + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } - ], - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "fdd239f3-931f-4add-8338-0766c6542472" + ] } } } @@ -57796,51 +36332,28 @@ } }, "404": { - "description": "Database, table, layout or layout section not found" + "description": "Database or table not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Layout Sections" + "Schema - Expressions" ], - "summary": "Update a layout section.", - "operationId": "UpdateSection", + "summary": "Create a new expression.", + "operationId": "CreateExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", "required": true, "schema": { "type": "string", @@ -57852,212 +36365,140 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "name": "Custom Properties" + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "803d85a4-47c8-4941-9c03-c8aa5b87236f" } }, "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "name": "Custom Properties" + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "803d85a4-47c8-4941-9c03-c8aa5b87236f" } }, "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "name": "Custom Properties" + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "803d85a4-47c8-4941-9c03-c8aa5b87236f" } }, "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaCreateExpression" }, "examples": { "Example 1": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + "summary": "Expression", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database.", "value": { - "name": "Custom Properties" + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression" } }, "Example 2": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified guid", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') in the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "name": "Simple expression with specified guid", + "guid": "803d85a4-47c8-4941-9c03-c8aa5b87236f" } }, "Example 3": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "summary": "Expression with specified unit", + "description": "This example demonstrates how to create a new expression for 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified unit 'ohm' from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "00000059-0013-4fff-8fff-0000ffff0000" + }, + "name": "Simple expression with specified unit" } } } @@ -58065,95 +36506,88 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFullLayoutSection" + "$ref": "#/components/schemas/GsaExpression" }, - "example": { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "discrete", - "required": false, - "readOnly": false, - "underlyingEntityGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "displayNames": {}, - "name": "Base", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - } - ], - "name": "Composition overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table, layout or section not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Layout Sections" - ], - "summary": "Delete a layout section.", - "operationId": "DeleteSection", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "section-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "examples": { + "Example 2": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" + }, + "attributeDependencies": [ + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" + } + ], + "constantDependencies": [], + "parameterDependencies": [ + { + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } + } + } + } } - } - ], - "responses": { - "200": { - "description": "Ok" }, "400": { "description": "Bad request" @@ -58162,43 +36596,38 @@ "description": "Forbidden" }, "404": { - "description": "Database, table, layout or layout section not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections/{section-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/expressions/{expression-guid}": { "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Expressions" ], - "summary": "Get a layout section with a specified guid.", - "operationId": "GetLayoutSectionWithoutLayout", + "summary": "Get an expression with a specified guid for a given database and table.", + "operationId": "GetExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "section-guid", + "name": "expression-guid", "in": "path", "required": true, "schema": { @@ -58206,13 +36635,6 @@ "format": "uuid" } }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, { "name": "mode", "in": "query", @@ -58244,139 +36666,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutSection" + "$ref": "#/components/schemas/GsaExpression" }, "examples": { - "Example 3": { - "summary": "Get 'slim' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", + "Example 1": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", "value": { - "detailType": "slim", - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - "name": "Testing Information", - "guid": "761acac6-1067-44a9-9ac3-e6ecd53bc04f" - } - }, - "Example 4": { - "summary": "Get 'full' layout section", - "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", - "value": { - "detailType": "full", - "sectionItems": [ + "attributeDependencies": [ { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "f7e45743-f130-4dba-879a-75c1aec7a9f3", - "displayNames": {}, - "name": "Form", - "guid": "a551aa33-bdc0-402a-97f9-52a792a6dcfd" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" }, { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [ - { - "itemType": "attribute", - "attributeType": "longText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "5285301d-20d1-4d6c-8a1a-e00549b34ddb", - "displayNames": {}, - "name": "Sources", - "guid": "279af0d6-cac5-4488-9c83-866e0d4204db" - }, - { - "itemType": "attribute", - "attributeType": "shortText", - "required": true, - "readOnly": false, - "underlyingEntityGuid": "2e771dda-acbf-45ce-a98d-a694d95b6411", - "displayNames": {}, - "name": "Notes", - "guid": "29cd1c1d-70ef-4bcf-92d4-5203b6c6f356" - } - ], - "underlyingEntityGuid": "2ab540e4-47db-4d65-a47b-d5552491c07b", - "displayNames": {}, - "name": "Chemical resistance", - "guid": "dfe9088f-b454-49e3-b697-c2f1e4ca81a0" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" }, { - "itemType": "link", - "linkType": "recordLink", - "targetDatabase": "3d60cb88-21f4-4e93-b916-cde04cf409aa", - "targetDatabaseVersion": "22914377-6541-4142-8ac0-36410bf5d955", - "targetTable": "121ad308-dbd9-4c49-9a67-72cedfc35331", - "forwards": true, - "underlyingEntityGuid": "b648838b-f807-4481-a581-417c24bf4ccf", - "displayNames": {}, - "name": "Material Pedigree", - "guid": "dbe93773-2705-4ff4-93ff-dbb8a2cfda12" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" }, { - "itemType": "attribute", - "attributeType": "link", - "required": false, - "readOnly": false, - "metaAttributes": [], - "tabularColumns": [ - { - "columnType": "linkedAttribute", - "tabularColumnGuid": "36e04f29-8364-489b-8c50-2b75f16a1589", - "name": "Offset Yield Stress", - "guid": "0f128ac0-8e65-48de-b2f2-cad07e0edbe7" - }, - { - "columnType": "localShortText", - "tabularColumnGuid": "80460982-dc82-4117-9b18-4eaa1c50a224", - "name": "Young's Modulus Notes", - "guid": "8f161f38-1e15-450b-99d0-45a23c700cff" - } - ], - "underlyingEntityGuid": "e23ee8b5-e7fa-471f-a8b9-f0f6eb89c134", - "displayNames": {}, - "name": "Reference Characteristics", - "guid": "c842b47d-7d79-42f7-9564-714bbe0bb438" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" }, { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "3d60cb88-21f4-4e93-b916-cde04cf409aa", - "targetDatabaseVersion": "22914377-6541-4142-8ac0-36410bf5d955", - "targetTable": "5a04f68a-619c-4fd6-9327-125353346d89", - "forwards": true, - "nextLink": { - "itemType": "link", - "linkType": "associationChain", - "targetDatabase": "3d60cb88-21f4-4e93-b916-cde04cf409aa", - "targetDatabaseVersion": "22914377-6541-4142-8ac0-36410bf5d955", - "targetTable": "f53fcd05-41ce-40c3-8ffb-669230488954", - "forwards": false, - "underlyingEntityGuid": "c293e424-081a-485f-8555-10cdd4b4fc70", - "displayNames": {}, - "name": "Pedigree information", - "guid": "a6180cec-e4aa-40d5-870f-a37d60894502" + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "underlyingEntityGuid": "ce4380c8-ce07-42df-a1b3-2a01c5cfa776", - "displayNames": {}, - "name": "To Pedigree from Producers", - "guid": "6b0ea684-3145-4cc9-8d15-d78bdc9de8d0" + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" } ], - "displayNames": { - "de": "Testing Information German Display Name", - "fr": "Testing Information French Display Name" - }, - "name": "Testing Information", - "guid": "7eabc903-7fd7-4d77-99e8-f4ee9adc2a80" + "constantDependencies": [], + "parameterDependencies": [ + { + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" } } } @@ -58384,41 +36745,36 @@ } }, "404": { - "description": "Database, table or layout section not found" + "description": "Database, table or expression not found" } } }, "patch": { "tags": [ - "Schema - Layout Sections" + "Schema - Expressions" ], - "summary": "Update a layout section.", - "operationId": "UpdateSectionWithoutLayout", + "summary": "Update an expression.", + "operationId": "UpdateExpression", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "section-guid", + "name": "expression-guid", "in": "path", "required": true, "schema": { @@ -58431,216 +36787,315 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } - }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "6aae6e0b-cda1-455a-bcb6-f82d5649fd7d" } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "name": "Fatigue Model (Updated)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } - }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "6aae6e0b-cda1-455a-bcb6-f82d5649fd7d" } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "name": "Fatigue Model (Updated)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", - "value": { - "name": "Custom Properties" - } - }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "6aae6e0b-cda1-455a-bcb6-f82d5649fd7d" } }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "name": "Fatigue Model (Updated)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayoutSection" + "$ref": "#/components/schemas/GsaUpdateExpression" }, "examples": { - "Example 4": { - "summary": "Rename Layout Section", - "description": "This example demonstrates how to rename a layout section.", + "Example 1": { + "summary": "Everything for an expression", + "description": "This example demonstrates how to update all properties of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Unit will be set to kg.", "value": { - "name": "Custom Properties" + "value": "[A:Tensile strength] + [P:Stress Ratio] * [A:Yield strength (elastic limit)] / log10(20000000) + 5", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue Model (Updated)", + "guid": "6aae6e0b-cda1-455a-bcb6-f82d5649fd7d" } }, - "Example 5": { - "summary": "Reorder Section Items", - "description": "This example demonstrates how to reorder layout items in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", + "Example 2": { + "summary": "Rename expression", + "description": "This example demonstrates how to update the 'Name' property of the 'Fatigue Model' expression (guid = 535074aa-216f-4f60-b13e-f5e8be72d05f) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "name": "Fatigue Model (Updated)" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaExpression" }, - "Example 6": { - "summary": "Insert Section Item", - "description": "This example demonstrates how to insert the 'Additive' attribute in the 'Composition overview' section (GUID = '937e77fe-70ca-4e99-b013-f9186bce45d3' in the 'Ceramics' layout (GUID = '00000b36-0009-4fff-8fff-dd92ffff0000') from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database. If any layout items in the section are not included in the request, they will be deleted.", - "value": { - "sectionItems": [ - { - "type": "update", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - }, - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false, - "type": "create" + "examples": { + "Example 3": { + "summary": "Get expression", + "description": "This example demonstrates the response to getting 'Fatigue Model' expression (GUID = '535074aa-216f-4f60-b13e-f5e8be72d05f') from 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from MI_Training database.", + "value": { + "value": "[A:Tensile strength] / ((1 + [P:Stress Ratio]) / (1 - [P:Stress Ratio]) + [A:Tensile strength] / (([A:Tensile strength] * (1 + [A:Elongation] / 100) - [A:Yield strength (elastic limit)]) / (log(1 + mean([A:Elongation] / 100)) - [A:Yield strength (elastic limit)] / (1000 * [A:Young's modulus])) * log(1 + mean([A:Elongation] / 100)) * (2 * [P:Number of Cycles]) ^ -0.6 + [A:Tensile strength] * (1 + [A:Elongation] / 100) * (2 * [P:Number of Cycles]) ^ (log10(mean([A:Fatigue strength at 10^7 cycles] / ([A:Tensile strength] * (1 + [A:Elongation] / 100)))) / log10(20000000))))", + "unit": { + "symbol": "MPa", + "guid": "0000002b-0013-4fff-8fff-0000ffff0000" }, - { - "type": "update", - "guid": "f4369b12-77ba-4343-87ea-38dbea211ddc" - } - ] + "attributeDependencies": [ + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Young's modulus", + "guid": "0000003f-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Tensile strength", + "guid": "000000e3-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Fatigue strength at 10^7 cycles", + "guid": "0000010c-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Elongation", + "guid": "0000011a-0001-4fff-8fff-dd92ffff0000" + }, + { + "type": "range", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "name": "Yield strength (elastic limit)", + "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" + } + ], + "constantDependencies": [], + "parameterDependencies": [ + { + "name": "Number of Cycles", + "guid": "00000007-000a-4fff-8fff-0000ffff0000" + }, + { + "name": "Stress Ratio", + "guid": "00000004-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Fatigue Model", + "guid": "535074aa-216f-4f60-b13e-f5e8be72d05f" + } } } } } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or expression not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Expressions" + ], + "summary": "Delete an expression.", + "operationId": "DeleteExpression", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "expression-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or expression not found" + } + } + } + }, + "/v1alpha/standard-names": { + "get": { + "tags": [ + "Schema - Global Standard Names" + ], + "summary": "Gets all standard names from all databases, optionally filtered by the provided 'name' query parameter.", + "operationId": "GetGlobalStandardNames", + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Standard name to match. Optional.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaStandardNamesInfo" + } + } + } + } + } + } + }, + "/v1alpha/standard-names:search": { + "post": { + "tags": [ + "Schema - Global Standard Names" + ], + "summary": "Find all standard names from all databases that match one of the names provided in the request.", + "operationId": "FindGlobalStandardNames", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindStandardNames" + } + } } }, "responses": { @@ -58649,86 +37104,139 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaFullLayoutSection" - }, - "example": { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "discrete", - "required": false, - "readOnly": false, - "underlyingEntityGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "displayNames": {}, - "name": "Base", - "guid": "b02f6a7a-4a7e-42f5-9c1f-ae0d38cd82bc" - } - ], - "name": "Composition overview", - "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + "$ref": "#/components/schemas/GsaStandardNamesInfo" } } } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database, table or section not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items": { - "post": { + "/v1alpha/databases/{database-key}/help-folders": { + "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Help Files" ], - "summary": "Add a new layout item.", - "operationId": "CreateLayoutItem", + "summary": "Get All Help File Folders", + "operationId": "GetHelpFolders", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + }, + { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + } } }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Create a new Help File Folder.", + "operationId": "CreateHelpFolder", + "parameters": [ { - "name": "section-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -58736,400 +37244,60 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true - } - }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] - } - }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] - } - }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "4fd6c4c8-3292-46e5-9735-1de847980ae1", - "sourceTableGuid": "a34482db-df60-42a8-b5ea-386a6cc7133c", - "linkGroupGuid": "a710e687-9896-4b10-96a6-20275077b402" - } - }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "c2ee4932-c4a7-47bd-82b8-647b27da71b1", - "tabularAttributeGuid": "7220f152-a7c5-44cd-b468-b9d2985c0269" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "70122311-9854-401f-bf90-9f9d3920ce8b", - "tabularAttributeGuid": "0572f9f5-1d18-44cd-bde4-ce6268b95edb" - } - ] + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true - } - }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] - } - }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] - } - }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "4fd6c4c8-3292-46e5-9735-1de847980ae1", - "sourceTableGuid": "a34482db-df60-42a8-b5ea-386a6cc7133c", - "linkGroupGuid": "a710e687-9896-4b10-96a6-20275077b402" - } - }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "c2ee4932-c4a7-47bd-82b8-647b27da71b1", - "tabularAttributeGuid": "7220f152-a7c5-44cd-b468-b9d2985c0269" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "70122311-9854-401f-bf90-9f9d3920ce8b", - "tabularAttributeGuid": "0572f9f5-1d18-44cd-bde4-ce6268b95edb" - } - ] + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true - } - }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] - } - }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] - } - }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "4fd6c4c8-3292-46e5-9735-1de847980ae1", - "sourceTableGuid": "a34482db-df60-42a8-b5ea-386a6cc7133c", - "linkGroupGuid": "a710e687-9896-4b10-96a6-20275077b402" - } - }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "c2ee4932-c4a7-47bd-82b8-647b27da71b1", - "tabularAttributeGuid": "7220f152-a7c5-44cd-b468-b9d2985c0269" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "70122311-9854-401f-bf90-9f9d3920ce8b", - "tabularAttributeGuid": "0572f9f5-1d18-44cd-bde4-ce6268b95edb" - } - ] + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaCreateFolder" }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with ReadOnly and Required properties set", - "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": true - } - }, - "Example 3": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": false, - "readOnly": false - } - ] - } - }, - "Example 4": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ] - } - }, - "Example 5": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - }, - "Example 6": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" - } - }, - "Example 7": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "4fd6c4c8-3292-46e5-9735-1de847980ae1", - "sourceTableGuid": "a34482db-df60-42a8-b5ea-386a6cc7133c", - "linkGroupGuid": "a710e687-9896-4b10-96a6-20275077b402" - } - }, - "Example 8": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "examples": { + "Example 1": { + "summary": "Help File Folder", + "description": "This example demonstrates how to create a new help file folder under the root 'Help Pages' folder.", "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "c2ee4932-c4a7-47bd-82b8-647b27da71b1", - "tabularAttributeGuid": "7220f152-a7c5-44cd-b468-b9d2985c0269" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "70122311-9854-401f-bf90-9f9d3920ce8b", - "tabularAttributeGuid": "0572f9f5-1d18-44cd-bde4-ce6268b95edb" - } - ] + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "New Folder" } } } @@ -59140,112 +37308,31 @@ "201": { "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaNewLayoutItem" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "Layout Attribute Item", - "description": "This example demonstrates the response to creating a new attribute layout item. It was created by adding the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": true, - "readOnly": false, - "metaAttributes": null, - "tabularColumnGuids": null, - "guid": "3e930ce6-4405-4e12-b5ef-85c93b3ba8ee" - } - }, - "Example 2": { - "summary": "Layout Attribute Item with Meta Attributes", - "description": "This example demonstrates the response to creating a new attribute layout item with a meta-attribute. It was created by adding the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "attribute", - "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false, - "metaAttributes": [ - { - "itemType": "attribute", - "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", - "required": true, - "readOnly": false - } - ], - "tabularColumnGuids": null, - "guid": "3f2de4c7-2d41-4aa8-afce-85c5d4bd8679" - } - }, - "Example 3": { - "summary": "Layout Attribute Item for a Tabular Attribute", - "description": "This example demonstrates the response to creating a new tabular attribute layout item with specified tabular columns to include. It was created by adding the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include. ", - "value": { - "itemType": "attribute", - "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", - "required": false, - "readOnly": false, - "metaAttributes": null, - "tabularColumnGuids": [ - "7b28a5fd-4972-40fc-8181-626586258bc3", - "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" - ], - "guid": null - } - }, - "Example 4": { - "summary": "Layout Record Link Group Item", - "description": "This example demonstrates the response to creating a new link group layout item. It was created by adding the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "recordLink", - "forwards": null, - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949", - "guid": null - } - }, - "Example 5": { - "summary": "Layout Smart Link Group Item", - "description": "This example demonstrates the response to creating a new smart link group layout item. It was created by adding the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "smartLink", - "forwards": true, - "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66", - "guid": null - } - }, - "Example 6": { - "summary": "Layout Cross Database Link Group Item", - "description": "This example demonstrates the response to creating a new cross database link group layout item. It was created by adding a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "crossDatabaseLink", - "sourceDatabaseGuid": "ae634373-c6d4-45c9-b9f1-5181fcc37c82", - "sourceTableGuid": "2a770a60-c286-4816-8781-ee45c2654d0a", - "linkGroupGuid": "0e5cd5ae-1375-4009-9464-23214d43eb3f", - "guid": null - } - }, - "Example 7": { - "summary": "Layout Association Chain Item", - "description": "This example demonstrates the response to creating a new association chain layout item. It was created by adding a association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "itemType": "associationChain", - "associationChainName": "Name of association chain", - "associationChainLinks": [ - { - "forwards": true, - "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", - "tabularAttributeGuid": "b8e8bc81-a2cf-4416-9b96-b26a1a3d4be7" - }, - { - "forwards": false, - "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", - "tabularAttributeGuid": "ad7883cc-d8da-44da-b9a6-f372e580e406" - } - ], - "guid": null - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } @@ -59257,61 +37344,85 @@ "description": "Forbidden" }, "404": { - "description": "Database, table, layout or layout section not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items/{item-guid}": { - "delete": { + "/v1alpha/databases/{database-key}/help-folders/:root-folder": { + "get": { "tags": [ - "Schema - Layout Sections" + "Schema - Help Files" ], - "summary": "Delete a layout item.", - "operationId": "DeleteItem", + "summary": "Get Root Help File Folder", + "operationId": "GetHelpRootFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } - }, - { - "name": "layout-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Help Pages", + "guid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } } }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get Help File Folder", + "operationId": "GetHelpFolder", + "parameters": [ { - "name": "section-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "item-guid", + "name": "folder-guid", "in": "path", "required": true, "schema": { @@ -59322,532 +37433,152 @@ ], "responses": { "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22", + "name": "html", + "guid": "99ff4816-15e9-42b9-9ac3-b60fce881e85" + } + } + } }, "404": { - "description": "Database, table, layout, layout section or layout section item not found" + "description": "Database or folder not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/sections:query": { - "post": { + }, + "patch": { "tags": [ - "Schema - Layout Sections" + "Schema - Help Files" ], - "summary": "Query all layout sections for table, optionally filter layout sections returned", - "operationId": "QueryLayoutSections", + "summary": "Update an existing Help File Folder.", + "operationId": "UpdateHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "application", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "cascadeFilter", - "in": "query", - "description": "If cascadeFilter is true, we apply the filter to the returned layout items, as well as filtering the layout sections themselves.", - "schema": { - "type": "boolean" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } + "name": "New Folder Name" } }, "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID 'dca41715-33b9-4493-940d-b47007bf804b'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '57c299fa-f562-44d9-8814-487bd54d8c29'.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "dca41715-33b9-4493-940d-b47007bf804b", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "57c299fa-f562-44d9-8814-487bd54d8c29", - "forwards": false - } - } + "guid": "0ae2b007-8232-428a-ae5a-a0fccc0cb03d" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } + "name": "New Folder Name" } }, "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID 'dca41715-33b9-4493-940d-b47007bf804b'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '57c299fa-f562-44d9-8814-487bd54d8c29'.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "dca41715-33b9-4493-940d-b47007bf804b", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "57c299fa-f562-44d9-8814-487bd54d8c29", - "forwards": false - } - } + "guid": "0ae2b007-8232-428a-ae5a-a0fccc0cb03d" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } + "name": "New Folder Name" } }, "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID 'dca41715-33b9-4493-940d-b47007bf804b'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '57c299fa-f562-44d9-8814-487bd54d8c29'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "dca41715-33b9-4493-940d-b47007bf804b", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "57c299fa-f562-44d9-8814-487bd54d8c29", - "forwards": false - } - } + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", + "value": { + "guid": "0ae2b007-8232-428a-ae5a-a0fccc0cb03d" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsRequest" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layout sections with the name 'General Properties', and return custom properties.", + "summary": "Rename Help File Folder", + "description": "This example demonstrates how to rename an existing help file folder.", "value": { - "properties": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } + "name": "New Folder Name" } }, "Example 2": { - "summary": "Filter by section name and return name and GUID", - "description": "Fetch all layout sections with the name 'General Properties'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": "General Properties" - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layout sections that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layout sections that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layout sections that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layout sections that contain a reverse cross database link group with GUID 'dca41715-33b9-4493-940d-b47007bf804b'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '57c299fa-f562-44d9-8814-487bd54d8c29'.", + "summary": "Change guid for Help File Folder", + "description": "This example demonstrates how to modify the guid of an existing help file folder.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "dca41715-33b9-4493-940d-b47007bf804b", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "57c299fa-f562-44d9-8814-487bd54d8c29", - "forwards": false - } - } + "guid": "0ae2b007-8232-428a-ae5a-a0fccc0cb03d" } } } @@ -59858,123 +37589,107 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionsInfo" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "Query layout sections with custom properties", - "description": "This example demonstrates the response to querying layout sections with custom properties.", - "value": { - "layoutSections": [ - { - "sectionItems": [ - { - "underlyingEntityGuid": "f22e2680-c476-4698-ab4c-750f298ff5a6", - "itemType": "attribute", - "name": "Price", - "guid": "9a636da0-f49e-4807-98a0-7b916ec9560f" - }, - { - "underlyingEntityGuid": "fa896edb-2c2f-4c35-84ee-3312dc50727b", - "itemType": "attribute", - "name": "Density", - "guid": "86abdcf5-302f-45ea-9859-b58a352640f8" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - } - ] - } - }, - "Example 2": { - "summary": "Query layout sections with name and GUID", - "description": "This example demonstrates the response to querying layout sections with name and GUID properties only.", - "value": { - "layoutSections": [ - { - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - } - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or table not found" + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts": { - "get": { + }, + "delete": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Get all layouts for table", - "operationId": "GetLayouts", + "summary": "Delete a Help File Folder.", + "operationId": "DeleteHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } + "403": { + "description": "Forbidden" }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:child-folders": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get Child Help File Folders", + "operationId": "GetHelpChildFolders", + "parameters": [ { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "database-key", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "application", - "in": "query", - "description": "Optionally filter by application that the layout is applicable to.", + "name": "folder-guid", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -59982,29 +37697,59 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" + }, + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayoutsInfo" + "$ref": "#/components/schemas/GsaFoldersInfo" }, "example": { - "layouts": [ + "folders": [ { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" }, { - "displayNames": {}, - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "attributenotes", + "guid": "c7db2cff-69ef-479d-b7a6-d12cfe888a56" }, { - "displayNames": {}, - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" + "parentGuid": "99ff4816-15e9-42b9-9ac3-b60fce881e85", + "name": "sciencenotes", + "guid": "38a6a798-4488-4c38-824e-0e41ce34932f" } ] } @@ -60012,36 +37757,33 @@ } }, "404": { - "description": "Database or table not found" + "description": "Database or folder not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}:move": { "post": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Create a new layout.", - "operationId": "CreateLayout", + "summary": "Move an existing Help File Folder.", + "operationId": "MoveHelpFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } @@ -60050,297 +37792,241 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Composite materials" - } - }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", - "value": { - "name": "Composite materials (guid)", - "guid": "e4b38d21-1c81-4400-a145-a3d6ca076d01" - } - }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", - "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" - } - }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" - }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Composite materials" - } - }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", - "value": { - "name": "Composite materials (guid)", - "guid": "e4b38d21-1c81-4400-a145-a3d6ca076d01" - } - }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", - "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" - } - }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" - }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "name": "Composite materials" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } - }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Help File Folder", + "description": "This example demonstrates how to move an existing help file folder to be under the root 'Help Pages' folder.", "value": { - "name": "Composite materials (guid)", - "guid": "e4b38d21-1c81-4400-a145-a3d6ca076d01" + "parentGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", - "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" - }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files": { + "get": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Get Files in a Folder", + "operationId": "GetHelpFiles", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateLayout" }, - "examples": { - "Example 1": { - "summary": "Layout", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "name": "Composite materials" - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" }, - "Example 2": { - "summary": "Layout with Guid", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", - "value": { - "name": "Composite materials (guid)", - "guid": "e4b38d21-1c81-4400-a145-a3d6ca076d01" - } + "example": { + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" }, - "Example 3": { - "summary": "Layout with applicable applications", - "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", - "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Composite materials (with applicable applications)" + "example": { + "files": [ + { + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + }, + { + "name": "Atomic_volume.html", + "guid": "94574853-3cfe-41d9-be48-391883fa0ea9" + } + ] + } + } + } + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "post": { + "tags": [ + "Schema - Help Files" + ], + "summary": "Create a new Help File.", + "operationId": "CreateHelpFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + }, + "description": { + "type": "string" } + } + }, + "encoding": { + "file": { + "style": "form" }, - "Example 4": { - "summary": "Layout with sections and items", - "description": "This example demonstrates how to create a new layout with populated sections for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "sections": [ - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "0000000d-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - }, - { - "itemType": "attribute", - "attributeGuid": "000001cb-0001-4fff-8fff-dd92ffff0000", - "required": false, - "readOnly": false - } - ], - "name": "General Properties" - }, - { - "sectionItems": [ - { - "itemType": "attribute", - "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", - "required": false, - "readOnly": false - }, - { - "itemType": "recordLink", - "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - } - ], - "name": "Additional Properties" - } - ], - "name": "Composite materials" - } + "description": { + "style": "form" } } } @@ -60350,15 +38036,46 @@ "201": { "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "7b4a139b-eebf-4d70-87f8-ca2575643569" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayout" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "applicableApplications": [], - "displayNames": {}, - "name": "Ceramics", - "guid": "20d3a659-2c1e-46ea-87ed-92069d171c19" + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "7b4a139b-eebf-4d70-87f8-ca2575643569" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "7b4a139b-eebf-4d70-87f8-ca2575643569" } } } @@ -60370,256 +38087,125 @@ "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}": { "get": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Get a layout with a specified guid for a given database and table.", - "operationId": "GetLayout", + "summary": "Get header information for a help file", + "operationId": "GetHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "showFullDetail", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayout" + "$ref": "#/components/schemas/GsaFileHeader" }, - "examples": { - "Example 1": { - "summary": "Layout with 'slim' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "sections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 2": { - "summary": "Layout with 'full' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", - "value": { - "sections": [ - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "0a8462f2-b109-4747-8463-3bfa4a6004af", - "displayNames": {}, - "name": "Price", - "guid": "b6209d67-77b0-4c3b-9e82-175c34505189" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "a9aba17c-88bf-410a-9d21-f4689e727345", - "displayNames": {}, - "name": "Density", - "guid": "d90b1c34-4914-4c02-861b-c9f6a9f2f4c3" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "5dc56f4b-b6d8-4392-9b10-df75fec52d0b", - "displayNames": {}, - "name": "Young's modulus", - "guid": "02f38c4d-8623-4cef-8cc6-20334d6a5a4d" - }, - { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "42153a9b-34d0-45e5-8bd4-b2b0777e13ac", - "displayNames": {}, - "name": "Tensile strength", - "guid": "95e77c1b-bc6b-4f88-a2be-fe77499ca001" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "171d2718-86c6-4055-b3f0-bcec173f4a9b", - "displayNames": {}, - "name": "Shape factor", - "guid": "69d84c2e-0a3a-4960-8569-6ae1c59985aa" - } - ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - } + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "cd34921a-67e6-43ff-adfe-3d36b6b3b5c7", + "description": "Description of Abrasion-rate file.", + "extension": "html", + "dataLength": 5090, + "path": "Help Pages\\html\\attributenotes\\en\\material", + "name": "Abrasion_rate.html", + "guid": "fdfcb207-63f7-4a10-87a3-054587444056" } } } }, "404": { - "description": "Database, table or layout not found" + "description": "Database, folder or file not found" } } }, "patch": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Update a layout.", - "operationId": "UpdateLayout", + "summary": "Update an existing Help File.", + "operationId": "UpdateHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { @@ -60632,132 +38218,112 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "0fc6f659-1f72-4f1b-bcf2-e9e23e191be8" + "name": "New File Name" } }, "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "Ceramics (Updated)" + "description": "New description for help file." } }, "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "applicableApplications": null + "guid": "7edf6d38-eb3a-4a92-a619-7c7f989f1f45" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "0fc6f659-1f72-4f1b-bcf2-e9e23e191be8" + "name": "New File Name" } }, "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "Ceramics (Updated)" + "description": "New description for help file." } }, "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "applicableApplications": null + "guid": "7edf6d38-eb3a-4a92-a619-7c7f989f1f45" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "0fc6f659-1f72-4f1b-bcf2-e9e23e191be8" + "name": "New File Name" } }, "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "Ceramics (Updated)" + "description": "New description for help file." } }, "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "applicableApplications": null + "guid": "7edf6d38-eb3a-4a92-a619-7c7f989f1f45" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateLayout" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Everything for a layout", - "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename Help File", + "description": "This example demonstrates how to rename an existing help file.", "value": { - "applicableApplications": [ - "MI:Explore", - "An Application" - ], - "name": "Ceramics (Updated)", - "guid": "0fc6f659-1f72-4f1b-bcf2-e9e23e191be8" + "name": "New File Name" } }, "Example 2": { - "summary": "Rename layout", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Modify the description for a Help File", + "description": "This example demonstrates how to change the description for an existing help file.", "value": { - "name": "Ceramics (Updated)" + "description": "New description for help file." } }, "Example 3": { - "summary": "Remove applicable applications from layout", - "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Change guid for Help File", + "description": "This example demonstrates how to modify the guid of an existing help file.", "value": { - "applicableApplications": null + "guid": "7edf6d38-eb3a-4a92-a619-7c7f989f1f45" } } } @@ -60768,15 +38334,46 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "cdc62586-82f9-4375-b7d1-773853e207ab" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLayout" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "applicableApplications": [], - "displayNames": {}, - "name": "Ceramics", - "guid": "6f0ae9f7-4281-45ed-9952-577234811a18" + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "cdc62586-82f9-4375-b7d1-773853e207ab" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "cdc62586-82f9-4375-b7d1-773853e207ab" } } } @@ -60788,41 +38385,36 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or layout not found" + "description": "Database, folder or file not found" } } }, "delete": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Delete a layout.", - "operationId": "DeleteLayout", + "summary": "Delete a Help File.", + "operationId": "DeleteHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { @@ -60835,937 +38427,371 @@ "200": { "description": "Ok" }, - "400": { - "description": "Bad request" - }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or layout not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/searchable-items": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:export": { "get": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Return the identifiers of items that should be included in a free text search over a specific layout", - "operationId": "GetSearchableItemsInLayout", + "summary": "Get help file as a file", + "operationId": "ExportHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "folder-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "layout-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GrantaMISearchFreeTextIdentifiers" - }, - "examples": { - "Example 3": { - "summary": "Layout with 'slim' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", - "value": { - "sections": [ - { - "sectionDetailType": "slim", - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "slim", - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 4": { - "summary": "Layout with 'full' sections", - "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", - "value": { - "sections": [ - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "21392fa8-5bf9-43cb-949c-7e8297a98ffb", - "displayNames": {}, - "name": "Price", - "guid": "b3ec71da-910b-4097-822d-2989e6272827" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": false, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "ca248b0e-bc25-4422-938c-8ed2b86e8cd7", - "displayNames": {}, - "name": "Density", - "guid": "f96250df-d15c-4ce4-b363-699c250e3564" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionDetailType": "full", - "sectionItems": [ - { - "itemType": "attribute", - "attributeType": "floatFunctional", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "ed4e45a6-2f4b-499c-9425-f5612efb519a", - "displayNames": {}, - "name": "Young's modulus", - "guid": "585d333a-09f7-4004-be34-5e7b8f261936" - }, - { - "itemType": "attribute", - "attributeType": "range", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "418b2787-1a2c-462b-8e13-475322b2d037", - "displayNames": {}, - "name": "Tensile strength", - "guid": "1eec1009-a95a-40d9-a244-446eaec48015" - }, - { - "itemType": "attribute", - "attributeType": "point", - "required": true, - "readOnly": false, - "metaAttributes": [], - "underlyingEntityGuid": "e78422d1-8410-448f-98a0-1b7c42cc787e", - "displayNames": {}, - "name": "Shape factor", - "guid": "29a6fff1-5fe5-4769-a913-b359efffd076" - } - ], - "displayNames": { - "en": "Mechanical Properties English Display Name", - "fr": "Mechanical Properties French Display Name" - }, - "name": "Mechanical Properties", - "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" - } - ], - "applicableApplications": [], - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - } - } - } - } + "description": "Ok" }, "404": { - "description": "Database, table or layout not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:applications": { - "get": { + "/v1alpha/databases/{database-key}/help-folders/{folder-guid}/files/{file-guid}:move": { + "post": { "tags": [ - "Schema - Layouts" + "Schema - Help Files" ], - "summary": "Returns applications that are either MI Applications, or in use in layouts in this table.\r\nCan be used as applicable applications for layouts.", - "operationId": "Applications", + "summary": "Move an existing Help File.", + "operationId": "MoveHelpFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "table-guid", + "name": "file-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "value": { + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "value": { + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "value": { + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Help File", + "description": "This example demonstrates how to move an existing help file to be under the root 'Help Pages' folder.", + "value": { + "folderGuid": "e7dbba58-b963-4d1f-bbf4-c8436d00bf22" + } + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "ebd8240e-70f6-4c05-93a1-ce5a879cb8e6" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaApplicationsInfo" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "applications": [ - "MI:Viewer", - "MI:Explore", - "MI:Materials Gateway", - "An Application" - ] + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "ebd8240e-70f6-4c05-93a1-ce5a879cb8e6" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "ebd8240e-70f6-4c05-93a1-ce5a879cb8e6" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database, folder or file not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:query": { - "post": { + "/v1alpha/databases/{database-key}/home-page-folders": { + "get": { "tags": [ - "Schema - Layouts" + "Schema - Home Pages" ], - "summary": "Query all layouts for table, optionally filter layouts returned", - "operationId": "QueryLayouts", + "summary": "Get All Home Page Folders", + "operationId": "GetHomePageFolders", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1cacd691-ea8d-4df9-a583-d94cb59009cb" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1cacd691-ea8d-4df9-a583-d94cb59009cb" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + }, + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1cacd691-ea8d-4df9-a583-d94cb59009cb" + } + ] + } + } } }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Create a new Home Page Folder.", + "operationId": "CreateHomePageFolder", + "parameters": [ { - "name": "application", - "in": "query", + "name": "database-key", + "in": "path", + "required": true, "schema": { "type": "string" } - }, - { - "name": "cascadeFilter", - "in": "query", - "description": "If cascadeFilter is true, we apply the filter to the returned layout sections and items, as well as filtering the layouts themselves.", - "schema": { - "type": "boolean" - } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "name": "General Properties" - } - } - } - }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID '496b9976-38cc-4605-8651-0c4059cb10aa'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '2e305729-c12a-45bc-967a-1287a8540c6e'.", + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "496b9976-38cc-4605-8651-0c4059cb10aa", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "2e305729-c12a-45bc-967a-1287a8540c6e", - "forwards": false - } - } - } + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "name": "General Properties" - } - } - } - }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID '496b9976-38cc-4605-8651-0c4059cb10aa'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '2e305729-c12a-45bc-967a-1287a8540c6e'.", + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "496b9976-38cc-4605-8651-0c4059cb10aa", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "2e305729-c12a-45bc-967a-1287a8540c6e", - "forwards": false - } - } - } + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "name": "General Properties" - } - } - } - }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID '496b9976-38cc-4605-8651-0c4059cb10aa'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '2e305729-c12a-45bc-967a-1287a8540c6e'.", + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "496b9976-38cc-4605-8651-0c4059cb10aa", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "2e305729-c12a-45bc-967a-1287a8540c6e", - "forwards": false - } - } - } + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsRequest" + "$ref": "#/components/schemas/GsaCreateFolder" }, "examples": { "Example 1": { - "summary": "Filter by section name", - "description": "Fetch all layouts that contain a section with the name 'General Properties', and return custom properties. Set the cascadeFilter query parameter to true to only include matching sections in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "name": "General Properties" - } - } - } - }, - "Example 2": { - "summary": "Layouts with attributes", - "description": "Fetch all layouts that contain attributes. Set the cascadeFilter query parameter to true to only include attribute items in the response.", - "value": { - "properties": { - "sections": { - "sectionItems": { - "underlyingEntityGuid": true, - "itemType": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute" - } - } - } - } - }, - "Example 3": { - "summary": "Filter by attribute", - "description": "Fetch all layouts that contain the attribute 'Metals', with GUID '0000000b-0001-4fff-8fff-dd92ffff0000'. This should be run in the table where the attribute is defined - 'Material Universe', with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "attribute", - "underlyingEntityGuid": "0000000b-0001-4fff-8fff-dd92ffff0000" - } - } - } - } - }, - "Example 4": { - "summary": "Filter by record link group", - "description": "Fetch all layouts that contain the record link group 'Tensile Test Data', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the forward direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the source table 'Metals Pedigree', with GUID 'ad27baf0-42e9-4136-bc96-9dbbf116e265'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": true - } - } - } - } - }, - "Example 5": { - "summary": "Filter by reverse record link group", - "description": "Fetch all layouts that contain the record link group 'Metals Pedigree', with GUID 'ac20ee4d-9ad2-4e39-91bc-668b0570904f', in the reverse direction. The link group's source table is 'Metals Pedigree', and target table is 'Tensile Test Data'. This should be run in the target table 'Tensile Test Data', with GUID '0dd5348e-72f3-4bcb-bb38-621e5953a333'.", - "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "ac20ee4d-9ad2-4e39-91bc-668b0570904f", - "linkType": "recordLink", - "forwards": false - } - } - } - } - }, - "Example 6": { - "summary": "Filter by reverse cross database link group", - "description": "Fetch all layouts that contain a reverse cross database link group with GUID '496b9976-38cc-4605-8651-0c4059cb10aa'. When filtering by a reverse cross database link group, the link group itself is in a different database, so specify either the TargetDatabase or TargetDatabaseVersion so that only the expected link group matches. TargetDatabaseVersion will always match at most one database, TargetDatabase could match more than one. TargetDatabaseVersion should not be set for a forward cross database link group, because it is not defined for forward cross database link groups. This example filters on cross database link groups that originate in the database with Version GUID '2e305729-c12a-45bc-967a-1287a8540c6e'.", + "summary": "Home Page Folder", + "description": "This example demonstrates how to create a new home page folder under the root 'Home Pages' folder.", "value": { - "properties": { - "displayNames": true, - "name": true, - "guid": true - }, - "filter": { - "sections": { - "sectionItems": { - "itemType": "link", - "underlyingEntityGuid": "496b9976-38cc-4605-8651-0c4059cb10aa", - "linkType": "crossDatabaseLink", - "targetDatabaseVersion": "2e305729-c12a-45bc-967a-1287a8540c6e", - "forwards": false - } - } - } + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "New Folder" } } } @@ -61773,104 +38799,64 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryLayoutsInfo" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "Query layouts with custom properties", - "description": "This example demonstrates the response to querying layouts with custom properties.", - "value": { - "layouts": [ - { - "sections": [ - { - "sectionItems": [ - { - "underlyingEntityGuid": "daa87463-43be-40e1-8855-747a5947e0e0", - "itemType": "attribute", - "name": "Price", - "guid": "c58f980a-7f1b-43a5-a0b1-599303984c1a" - }, - { - "underlyingEntityGuid": "a990872a-8d09-43be-924a-5f62f91ef082", - "itemType": "attribute", - "name": "Density", - "guid": "7605175e-a5af-4cf8-af2f-b96833036e31" - } - ], - "displayNames": { - "en": "General Properties English Display Name", - "fr": "General Properties French Display Name" - }, - "name": "General Properties", - "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" - }, - { - "sectionItems": [], - "displayNames": {}, - "name": "Further information", - "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" - } - ], - "displayNames": {}, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - ] - } - }, - "Example 2": { - "summary": "Query layouts with name and GUID", - "description": "This example demonstrates the response to querying layouts with name and GUID properties only.", - "value": { - "layouts": [ - { - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - } - ] - } - } + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or table not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/parameters": { + "/v1alpha/databases/{database-key}/home-page-folders:root-folder": { "get": { "tags": [ - "Schema - Parameters" + "Schema - Home Pages" ], - "summary": "Get all parameters for a given database.", - "operationId": "GetParameters", + "summary": "Get Root Home Page Folder", + "operationId": "GetHomePageRootFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -61878,125 +38864,130 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParametersInfo" + "$ref": "#/components/schemas/GsaFolder" }, - "examples": { - "Example 1": { - "summary": "A mix of parameters", - "description": "This example contains a mix of numeric and discrete parameters from the MI_Training database.", - "value": { - "parameters": [ - { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "numeric", - "isRestricted": false, - "values": [ - { - "type": "numeric", - "value": -1.0, - "guid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94" - }, - { - "type": "numeric", - "value": 0.0, - "guid": "00000022-000b-4fff-8fff-0022ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94", - "displayNames": { - "en": "Strain Ratio", - "fr": "Rapport de contrainte" - }, - "name": "Strain Ratio", - "guid": "00000022-000a-4fff-8fff-0000ffff0000" - }, - { - "type": "discrete", - "values": [ - { - "type": "discrete", - "name": "Mean", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - }, - { - "type": "discrete", - "name": "A-basis", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "B-basis", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - } - ], - "defaultParameterValueGuid": "21a27377-12eb-413c-bac4-d4ffceda39d1", - "displayNames": { - "en": "Basis", - "fr": "Base" - }, - "name": "Basis", - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - } - } + "example": { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Home Pages", + "guid": "c13eb185-2558-4b4a-8395-33c031663925" + } + } + } + }, + "404": { + "description": "Database not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}": { + "get": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Get Home Page Folder", + "operationId": "GetHomePageFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1775b898-5828-4587-ac39-c79a34291f95" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1775b898-5828-4587-ac39-c79a34291f95" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "1775b898-5828-4587-ac39-c79a34291f95" } } } }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Parameters" + "Schema - Home Pages" ], - "summary": "Create a new parameter.", - "operationId": "CreateParameter", + "summary": "Update an existing Home Page Folder.", + "operationId": "UpdateHomePageFolder", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -62004,548 +38995,332 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "values": [ - { - "type": "discrete", - "name": "Red" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "892ed719-3a6d-4ce2-bfdf-0e8c4e82abd5" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "880744f6-1863-4b9a-8d92-d753a8074513" - } - }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" - }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "guid": "037ee667-7841-4a76-9a6f-c4cd8662c28b" } - }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFolder" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "name": "New Folder Name" } }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "guid": "037ee667-7841-4a76-9a6f-c4cd8662c28b" } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" + "$ref": "#/components/schemas/GsaUpdateFolder" }, "examples": { "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "values": [ - { - "type": "discrete", - "name": "Red" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" + "name": "New Folder Name" } }, "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "892ed719-3a6d-4ce2-bfdf-0e8c4e82abd5" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "880744f6-1863-4b9a-8d92-d753a8074513" + "guid": "037ee667-7841-4a76-9a6f-c4cd8662c28b" } - }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFolder" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page Folder", + "description": "This example demonstrates how to rename an existing home page folder.", "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" - }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" + "name": "New Folder Name" } }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "Example 2": { + "summary": "Change guid for Home Page Folder", + "description": "This example demonstrates how to modify the guid of an existing home page folder.", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "guid": "037ee667-7841-4a76-9a6f-c4cd8662c28b" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", - "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Delete a Home Page Folder.", + "operationId": "DeleteHomePageFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:child-folders": { + "get": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Get Child Home Page Folders", + "operationId": "GetHomePageChildFolders", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "ed8d4eec-b302-4050-bbed-0ccc2f7315e9" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "ed8d4eec-b302-4050-bbed-0ccc2f7315e9" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFoldersInfo" + }, + "example": { + "folders": [ + { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "name": "images", + "guid": "ed8d4eec-b302-4050-bbed-0ccc2f7315e9" + } + ] + } + } + } + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}:move": { + "post": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Move an existing Home Page Folder.", + "operationId": "MoveHomePageFolder", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", + "value": { + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" } } } }, - "text/json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" - } - }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "892ed719-3a6d-4ce2-bfdf-0e8c4e82abd5" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "880744f6-1863-4b9a-8d92-d753a8074513" - } - }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", - "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" - }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" - } - }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" } - }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFolder" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateParameter" + "$ref": "#/components/schemas/GsaMoveFolder" }, "examples": { "Example 1": { - "summary": "Discrete Parameter", - "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 0, - "name": "Color" - } - }, - "Example 2": { - "summary": "Discrete Parameter with Guids", - "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", - "value": { - "values": [ - { - "type": "discrete", - "name": "Red", - "guid": "892ed719-3a6d-4ce2-bfdf-0e8c4e82abd5" - }, - { - "type": "discrete", - "name": "Green" - } - ], - "type": "discrete", - "defaultParameterValueIndex": 1, - "name": "Color (guid)", - "guid": "880744f6-1863-4b9a-8d92-d753a8074513" - } - }, - "Example 3": { - "summary": "Numeric Restricted Parameter", - "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", - "value": { - "type": "numeric", - "isRestricted": true, - "values": [ - { - "value": 2010.0, - "type": "numeric", - "name": "Twenty Ten" - }, - { - "value": 2015.0, - "type": "numeric" - }, - { - "value": 2020.0, - "type": "numeric", - "name": "Twenty Twenty" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 2, - "name": "Year" - } - }, - "Example 4": { - "summary": "Numeric Restricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", - "value": { - "type": "numeric", - "isRestricted": true, - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Small box" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Big box" - } - ], - "interpolationType": "none", - "scaleType": "linear", - "defaultParameterValueIndex": 0, - "name": "Box dimension" - } - }, - "Example 5": { - "summary": "Numeric Unrestricted Parameter with Unit", - "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "summary": "Move Home Page Folder", + "description": "This example demonstrates how to move an existing home page folder to be under the root 'Home Pages' folder.", "value": { - "type": "numeric", - "isRestricted": false, - "unit": { - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "value": 10.0, - "type": "numeric", - "name": "Cold" - }, - { - "value": 20.0, - "type": "numeric" - }, - { - "value": 30.0, - "type": "numeric", - "name": "Hot" - } - ], - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueIndex": 2, - "name": "Outside Temperature" + "parentGuid": "c13eb185-2558-4b4a-8395-33c031663925" } } } @@ -62553,136 +39328,276 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameter" + "$ref": "#/components/schemas/GsaFolder" }, "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFolder" + }, + "example": { + "name": "Exporters", + "guid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44" } } } }, "400": { - "description": "Bad request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or folder not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files": { + "get": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Get the Home Page Files in a Folder", + "operationId": "GetHomePageFiles", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "3b0c4aa6-fd55-45e4-ae81-1436294d6a83" + }, + { + "name": "home-page-2.html", + "guid": "69eef9e5-0ef1-4290-9762-3579362b2ab0" + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameterCreationException" + "$ref": "#/components/schemas/GsaFilesInfo" }, - "examples": { - "Example 1": { - "summary": "No parameter values", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a parameter with name 'Color', but did not provide any parameter values. At least one parameter value is required.", - "value": { - "message": "Cannot create parameter 'Color'.", - "code": "parameterCreation", - "name": "Color", - "errors": [ - { - "message": "No parameter values provided", - "reason": "noParameterValues" - } - ] + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "3b0c4aa6-fd55-45e4-ae81-1436294d6a83" + }, + { + "name": "home-page-2.html", + "guid": "69eef9e5-0ef1-4290-9762-3579362b2ab0" } - }, - "Example 2": { - "summary": "Multiple validation errors for creating a numeric parameter", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a parameter with name 'Outside Temperature'. The unit GUID provided did not match any known unit. The parameter scaleType was set to 'logarithmic' but one of the parameter values is less than or equal to zero.", - "value": { - "message": "Cannot create parameter 'Outside Temperature'.", - "code": "parameterCreation", - "name": "Outside Temperature", - "errors": [ - { - "message": "Could not find unit with GUID 'e69193a3-35df-4516-b1b1-e431f4d617d8'.", - "guid": "e69193a3-35df-4516-b1b1-e431f4d617d8", - "reason": "noSuchUnit" - }, - { - "message": "Parameter value is not valid.", - "errors": [ - { - "message": "For a log-scale parameter, all values must be greater than zero.", - "reason": "logScaleNegative" - } - ], - "reason": "parameterValue" - } - ] + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFilesInfo" + }, + "example": { + "files": [ + { + "name": "home-page-1.html", + "guid": "3b0c4aa6-fd55-45e4-ae81-1436294d6a83" + }, + { + "name": "home-page-2.html", + "guid": "69eef9e5-0ef1-4290-9762-3579362b2ab0" } + ] + } + } + } + }, + "404": { + "description": "Database or folder not found" + } + } + }, + "post": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Create a new Home Page File.", + "operationId": "CreateHomePageFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateNumericParameter: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } + "description": { + "type": "string" } } + }, + "encoding": { + "file": { + "style": "form" + }, + "description": { + "style": "form" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1fafa9d0-8780-4f7b-a555-74e3f6b3bc80" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1fafa9d0-8780-4f7b-a555-74e3f6b3bc80" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "1fafa9d0-8780-4f7b-a555-74e3f6b3bc80" + } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or folder not found" } } } }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}": { + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}": { "get": { "tags": [ - "Schema - Parameters" + "Schema - Home Pages" ], - "summary": "Get a parameter with a specified guid for a given database.", - "operationId": "GetParameter", + "summary": "Get the header information for a Home Page File", + "operationId": "GetHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "parameter-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { @@ -62695,67 +39610,81 @@ "200": { "description": "Ok", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "6a269fd2-9432-4c3c-81d7-ae54ff9e38fa" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameter" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "6a269fd2-9432-4c3c-81d7-ae54ff9e38fa" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925", + "description": "Description of home page file.", + "extension": "html", + "dataLength": 12895, + "path": "HomePages", + "name": "home-page.html", + "guid": "6a269fd2-9432-4c3c-81d7-ae54ff9e38fa" } } } }, "404": { - "description": "Database or parameter not found" + "description": "Database, folder or file not found" } } }, "patch": { "tags": [ - "Schema - Parameters" + "Schema - Home Pages" ], - "summary": "Update a parameter.", - "operationId": "UpdateParameter", + "summary": "Update an existing Home Page File.", + "operationId": "UpdateHomePageFile", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "parameter-guid", + "name": "file-guid", "in": "path", "required": true, "schema": { @@ -62768,408 +39697,358 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "9778ce69-1a24-42f9-a729-72c4fdb48959" + "name": "New File Name" } }, "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "3d662438-52da-4251-9d8f-649db39fab15" + "description": "New description for home page file." } }, "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", - "value": { - "type": "numeric", - "guid": "4414b9c2-8d34-4bc8-bd2c-3b6e1aa17d49" - } - }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" - } - }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "guid": "5b2c7e47-9b48-4b62-b7bd-db245b3f58e2" - } - }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", - "value": { - "type": "numeric", - "unit": null - } - }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", - "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" - } - }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] + "guid": "45755fcf-d4cf-4b27-b327-124110ba8f6a" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "9778ce69-1a24-42f9-a729-72c4fdb48959" + "name": "New File Name" } }, "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "3d662438-52da-4251-9d8f-649db39fab15" + "description": "New description for home page file." } }, "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", - "value": { - "type": "numeric", - "guid": "4414b9c2-8d34-4bc8-bd2c-3b6e1aa17d49" - } - }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" - } - }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "guid": "5b2c7e47-9b48-4b62-b7bd-db245b3f58e2" + "guid": "45755fcf-d4cf-4b27-b327-124110ba8f6a" } - }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateFile" + }, + "examples": { + "Example 1": { + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", "value": { - "type": "numeric", - "unit": null + "name": "New File Name" } }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + "Example 2": { + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "description": "New description for home page file." } }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "Example 3": { + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] + "guid": "45755fcf-d4cf-4b27-b327-124110ba8f6a" } } } }, - "text/json": { + "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" + "$ref": "#/components/schemas/GsaUpdateFile" }, "examples": { "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", + "summary": "Rename Home Page File", + "description": "This example demonstrates how to rename an existing home page file.", "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "9778ce69-1a24-42f9-a729-72c4fdb48959" + "name": "New File Name" } }, "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", + "summary": "Modify the description for a Home Page File", + "description": "This example demonstrates how to change the description for an existing home page file.", "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "3d662438-52da-4251-9d8f-649db39fab15" + "description": "New description for home page file." } }, "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", + "summary": "Change guid for Home Page File", + "description": "This example demonstrates how to modify the guid of an existing home page file.", "value": { - "type": "numeric", - "guid": "4414b9c2-8d34-4bc8-bd2c-3b6e1aa17d49" + "guid": "45755fcf-d4cf-4b27-b327-124110ba8f6a" } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "503c2b3d-bd42-468a-a461-89f8f04c9345" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "guid": "5b2c7e47-9b48-4b62-b7bd-db245b3f58e2" - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "503c2b3d-bd42-468a-a461-89f8f04c9345" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "503c2b3d-bd42-468a-a461-89f8f04c9345" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, folder or file not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Delete a Home Page File.", + "operationId": "DeleteHomePageFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:export": { + "get": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Get Home Page File as a file", + "operationId": "ExportHomePageFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database, folder or file not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/home-page-folders/{folder-guid}/files/{file-guid}:move": { + "post": { + "tags": [ + "Schema - Home Pages" + ], + "summary": "Move an existing Home Page File.", + "operationId": "MoveHomePageFile", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "folder-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "file-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", "value": { - "type": "numeric", - "unit": null + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" } - }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" } - }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaMoveFile" + }, + "examples": { + "Example 1": { + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateParameter" + "$ref": "#/components/schemas/GsaMoveFile" }, "examples": { "Example 1": { - "summary": "Numeric parameter", - "description": "This example shows how to update properties of the 'Strain' numeric parameter (GUID ='00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "interpolationType": "cubicSpline", - "scaleType": "logarithmic", - "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", - "name": "Strain (Updated)", - "guid": "9778ce69-1a24-42f9-a729-72c4fdb48959" - } - }, - "Example 2": { - "summary": "Discrete parameter", - "description": "This example shows how to update properties of the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database.", - "value": { - "type": "discrete", - "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "name": "Basis (Updated)", - "guid": "3d662438-52da-4251-9d8f-649db39fab15" - } - }, - "Example 3": { - "summary": "Update Guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Guid can be updated for both kinds of parameters.", - "value": { - "type": "numeric", - "guid": "4414b9c2-8d34-4bc8-bd2c-3b6e1aa17d49" - } - }, - "Example 4": { - "summary": "Update Name", - "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Name can be updated for both kinds of parameters.", - "value": { - "type": "discrete", - "name": "Strain (Updated)" - } - }, - "Example 5": { - "summary": "Update Guid and Unit", - "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", - "value": { - "type": "numeric", - "unit": { - "guid": "0000007a-0013-4fff-8fff-0000ffff0000" - }, - "guid": "5b2c7e47-9b48-4b62-b7bd-db245b3f58e2" - } - }, - "Example 6": { - "summary": "Remove Unit", - "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database by setting it to null.", - "value": { - "type": "numeric", - "unit": null - } - }, - "Example 7": { - "summary": "Change interpolation and scale type", - "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (GUID = '00000005-000a-4fff-8fff-0000ffff0000') from the MI_Training database. The parameter must be a numeric parameter.", - "value": { - "type": "numeric", - "interpolationType": "cubicSpline", - "scaleType": "logarithmic" - } - }, - "Example 8": { - "summary": "Update Values", - "description": "This example shows how to update parameter values on the 'Basis' discrete parameter (GUID = '7a6ccb7b-8a47-4cab-8203-c741d476560f') from the MI_Training database. A new value 'New Value' will be added between the existing values 'A-basis' (GUID = '505b5d32-0a4a-48af-9a7a-90c4caacd35c') and 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b'). The value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1') will be moved to the end. The existing value 'B-basis' (GUID = '9ba94816-6784-4848-bfa6-d24b12597a5b') will be renamed.", + "summary": "Move Home Page File", + "description": "This example demonstrates how to move an existing home page file to be under the root 'Home Pages' folder.", "value": { - "type": "discrete", - "values": [ - { - "type": "discrete", - "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" - }, - { - "type": "discrete", - "name": "New Value" - }, - { - "type": "discrete", - "name": "B-basis - renamed", - "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" - }, - { - "type": "discrete", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" - } - ] + "folderGuid": "c13eb185-2558-4b4a-8395-33c031663925" } } } @@ -63180,200 +40059,278 @@ "200": { "description": "Ok", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaParameter" + "$ref": "#/components/schemas/GsaFileHeader" }, "example": { - "type": "numeric", - "isRestricted": false, - "unit": { - "symbol": "% strain", - "guid": "0000019b-0013-4fff-8fff-0000ffff0000" - }, - "values": [ - { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - }, - { - "type": "numeric", - "value": 1.0, - "guid": "00000005-000b-4fff-8fff-0005ffff0000" - } - ], - "interpolationType": "linear", - "scaleType": "linear", - "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", - "displayNames": { - "en": "Strain", - "fr": "Souche" - }, - "name": "Strain", - "guid": "00000005-000a-4fff-8fff-0000ffff0000" + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "5b6e8a8e-5396-4b31-a6db-777899c9ffc9" } - } - } - }, - "400": { - "description": "Bad request", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameterUpdateException" + "$ref": "#/components/schemas/GsaFileHeader" }, - "examples": { - "Example 1": { - "summary": "No such unit", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the unit of the 'Temperature' parameter with GUID '00000001-000a-4fff-8fff-0000ffff0000', but the unit GUID provided did not match any known unit.", - "value": { - "message": "Cannot update parameter with GUID '00000001-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterUpdate", - "parameterGuid": "00000001-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Could not find unit with GUID 'da058ac7-0194-47ec-801f-460a9a2cf379'.", - "guid": "da058ac7-0194-47ec-801f-460a9a2cf379", - "reason": "noSuchUnit" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for updating a numeric parameter", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'Stress Ratio' parameter with GUID '00000004-000a-4fff-8fff-0000ffff0000'. The unit GUID provided did not match any known unit. The parameter scaleType was set to 'logarithmic', which is invalid because one of the parameter values is less than or equal to zero.", - "value": { - "message": "Cannot update parameter with GUID '00000004-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterUpdate", - "parameterGuid": "00000004-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Could not find unit with GUID '5702ac97-8cfe-4666-b889-d9f5b0789fb1'.", - "guid": "5702ac97-8cfe-4666-b889-d9f5b0789fb1", - "reason": "noSuchUnit" - }, - { - "message": "Parameter value is not valid.", - "errors": [ - { - "message": "For a log-scale parameter, all values must be greater than zero.", - "reason": "logScaleNegative" - } - ], - "reason": "parameterValue" - } - ] - } - } + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "5b6e8a8e-5396-4b31-a6db-777899c9ffc9" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFileHeader" + }, + "example": { + "folderGuid": "c4e0bbbd-71b3-4bf7-ac6e-7ceeef058a44", + "description": "Description of exporter file.", + "extension": "exp", + "dataLength": 12895, + "path": "Exporters", + "name": "exporter-1.exp", + "guid": "5b6e8a8e-5396-4b31-a6db-777899c9ffc9" } } } }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or parameter not found" + "description": "Database, folder or file not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections": { + "get": { "tags": [ - "Schema - Parameters" + "Schema - Layout Sections" ], - "summary": "Delete a parameter.", - "operationId": "DeleteParameter", + "summary": "Get all sections for a layout", + "operationId": "GetLayoutSections", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "parameter-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "showFullDetail", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { - "400": { - "description": "Bad request. Parameter in use.", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameterDeletionException" + "$ref": "#/components/schemas/GsaLayoutSectionsInfo" }, - "example": { - "message": "Cannot delete parameter with GUID '00000005-000a-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "guid": "00000005-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ + "examples": { + "Example 1": { + "summary": "Get 'slim' layout sections", + "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to false, which is the default value.", + "value": { + "layoutSections": [ { - "type": "floatFunctional", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" }, - "name": "Tensile strength with temperature", - "guid": "00000002-0001-4fff-8fff-dd92ffff0000" + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" } ] } - ] + }, + "Example 2": { + "summary": "Get 'full' layout sections", + "description": "This example demonstrates the response to getting the sections for a layout with the 'showFullDetail' parameter set to true.", + "value": { + "layoutSections": [ + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "254919d1-3a74-49d8-93d4-b0f42fa10ee4", + "name": "Price", + "guid": "ca382a4d-0b1d-447c-b28f-1129cacbb451" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "4f3f130a-0ef3-4f8d-a8ee-0abb092cd468", + "name": "Density", + "guid": "87b8ed57-3b37-4485-9cb7-22b0fbebea0b" + } + ], + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "floatFunctional", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "e28ca26a-1f6f-4ee4-8c93-46983a0f9e5b", + "name": "Young's modulus", + "guid": "86619b3b-4b7e-4bd5-8fb1-5a0d66d5d379" + }, + { + "itemType": "attribute", + "attributeType": "range", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "bcbf6cd4-c556-48f6-86a1-f482c16367c2", + "name": "Tensile strength", + "guid": "9cf54e6f-fba6-4d65-8409-5299c2b2d99a" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "00201e5d-b48c-44d9-86f9-d86b0befdfec", + "name": "Shape factor", + "guid": "af6832bf-adc2-44a4-b296-92c006a983ac" + } + ], + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + } + ] + } + } } } } }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, "404": { - "description": "Database or parameter not found" + "description": "Database, table or layout not found" } } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}:usages": { - "get": { + }, + "post": { "tags": [ - "Schema - Parameters" + "Schema - Layout Sections" ], - "summary": "Get attributes which currently use the given parameter.", - "operationId": "GetObjectsUsingParameter", + "summary": "Create a new layout section.", + "operationId": "CreateSection", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "parameter-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { @@ -63382,44 +40339,143 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateLayoutSection" + }, + "examples": { + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Additional Properties" + } + }, + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "Additional Properties (Guid)", + "guid": "61e752a3-9fe1-4d78-802d-9d9948b796a3" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateLayoutSection" + }, + "examples": { + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Additional Properties" + } + }, + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "Additional Properties (Guid)", + "guid": "61e752a3-9fe1-4d78-802d-9d9948b796a3" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateLayoutSection" + }, + "examples": { + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Additional Properties" + } + }, + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "Additional Properties (Guid)", + "guid": "61e752a3-9fe1-4d78-802d-9d9948b796a3" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateLayoutSection" + }, + "examples": { + "Example 1": { + "summary": "Layout Section", + "description": "This example demonstrates how to create a new layout section in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "name": "Additional Properties" + } + }, + "Example 2": { + "summary": "Layout Section with Guid", + "description": "This example demonstrates how to create a new layout section with a specified guid value in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "name": "Additional Properties (Guid)", + "guid": "61e752a3-9fe1-4d78-802d-9d9948b796a3" + } + } + } + } + } + }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSlimObjects" + "$ref": "#/components/schemas/GsaSlimLayoutSection" + }, + "example": { + "sectionDetailType": "slim", + "displayNames": {}, + "name": "Additional Properties", + "guid": "21b9bb89-9348-4c33-96f1-19e13fcf8063" } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or parameter not found" + "description": "Database, table or layout not found" } } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values/{parameter-value-guid}": { - "get": { + }, + "put": { "tags": [ - "Schema - Parameters" + "Schema - Layout Sections" ], - "summary": "Get a parameter value with a specified guid for a given database for a given parameter.", - "operationId": "GetParameterValue", + "summary": "Reorder the list of layout sections for a layout.", + "operationId": "ReorderSections", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "parameter-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -63428,7 +40484,7 @@ } }, { - "name": "parameter-value-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { @@ -63437,47 +40493,523 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaReorderSectionsInfo" + }, + "examples": { + "Example 1": { + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaReorderSectionsInfo" + }, + "examples": { + "Example 1": { + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaReorderSectionsInfo" + }, + "examples": { + "Example 1": { + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaReorderSectionsInfo" + }, + "examples": { + "Example 1": { + "summary": "Reorder Layout Sections", + "description": "This example demonstrates how to reorder sections in the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "layoutSections": [ + { + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameterValue" + "$ref": "#/components/schemas/GsaLayoutSectionsInfo" }, "example": { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + "layoutSections": [ + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Electrical Properties English Display Name", + "fr": "Electrical Properties French Display Name" + }, + "name": "Electrical Properties", + "guid": "07124fac-3100-444f-ad5b-385decd9539f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Composition Overview English Display Name", + "fr": "Composition Overview French Display Name" + }, + "name": "Composition Overview", + "guid": "937e77fe-70ca-4e99-b013-f9186bce45d3" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Composition detail (metals, ceramics and glasses) English Display Name", + "fr": "Composition detail (metals, ceramics and glasses) French Display Name" + }, + "name": "Composition detail (metals, ceramics and glasses)", + "guid": "6f610145-72f9-4c11-aa72-6cbe268e9238" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Restricted substances English Display Name", + "fr": "Restricted substances French Display Name" + }, + "name": "Restricted substances", + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Further Information English Display Name", + "fr": "Further Information French Display Name" + }, + "name": "Further Information", + "guid": "6a5788ea-1a46-4806-a9d7-916a2eebb71c" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Restricted substances English Display Name", + "fr": "Restricted substances French Display Name" + }, + "name": "Restricted substances", + "guid": "f2587e4f-36b4-4b75-8ecb-853e51adf3a5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Notes English Display Name", + "fr": "Notes French Display Name" + }, + "name": "Notes", + "guid": "e243499b-3369-45db-bf3e-3c0dbb82f57f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material recycling: energy, CO2 and recycle fraction English Display Name", + "fr": "Material recycling: energy, CO2 and recycle fraction French Display Name" + }, + "name": "Material recycling: energy, CO2 and recycle fraction", + "guid": "b175f578-cf61-4642-9b98-eda48578db1e" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material processing: CO2 footprint English Display Name", + "fr": "Material processing: CO2 footprint French Display Name" + }, + "name": "Material processing: CO2 footprint", + "guid": "268854a1-1886-4bbf-b6aa-02aa64020fac" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Material processing: energy English Display Name", + "fr": "Material processing: energy French Display Name" + }, + "name": "Material processing: energy", + "guid": "3bde950b-9320-439e-8e7a-cf12c54eb94d" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Eco-indicators for principal component English Display Name", + "fr": "Eco-indicators for principal component French Display Name" + }, + "name": "Eco-indicators for principal component", + "guid": "3b829b2a-bfca-4531-9532-834eedcc0778" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Primary material production: energy, CO2 and water English Display Name", + "fr": "Primary material production: energy, CO2 and water French Display Name" + }, + "name": "Primary material production: energy, CO2 and water", + "guid": "b9d84ce2-9435-4f22-9377-9db56fb80c53" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Geo-economic data for principal component English Display Name", + "fr": "Geo-economic data for principal component French Display Name" + }, + "name": "Geo-economic data for principal component", + "guid": "3be73930-15a2-4dca-a818-3e18aa6081aa" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Durability: fluids and sunlight English Display Name", + "fr": "Durability: fluids and sunlight French Display Name" + }, + "name": "Durability: fluids and sunlight", + "guid": "83ba3aad-cb2f-49df-89e5-091017087563" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Durability: flammability English Display Name", + "fr": "Durability: flammability French Display Name" + }, + "name": "Durability: flammability", + "guid": "0c17f625-debe-4b6a-bcde-d60f3db571f5" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Optical properties English Display Name", + "fr": "Optical properties French Display Name" + }, + "name": "Optical properties", + "guid": "461c81d8-ecb4-4675-a05d-2dfef747db71" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Thermal properties English Display Name", + "fr": "Thermal properties French Display Name" + }, + "name": "Thermal properties", + "guid": "5b986b6d-ce14-48fd-b5a9-6286b9983954" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Bio-data English Display Name", + "fr": "Bio-data French Display Name" + }, + "name": "Bio-data", + "guid": "d15a87a0-2880-4508-af1e-381a2aa9e831" + } + ] } } } }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database, parameter or parameter value not found" + "description": "Database, table, layout or layout section not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}": { + "get": { "tags": [ - "Schema - Parameters" + "Schema - Layout Sections" ], - "summary": "Update a parameter value.", - "operationId": "UpdateParameterValue", + "summary": "Get a layout section with a specified guid for a given layout.", + "operationId": "GetLayoutSection", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "parameter-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -63486,265 +41018,16 @@ } }, { - "name": "parameter-value-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "49afb1f4-6217-4e49-89c6-1b9cbc2ac459" - } - }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "6d7e5f06-5896-41a8-a821-0c7be723346d" - } - }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", - "value": { - "type": "numeric", - "guid": "5a24343c-5ec1-407e-b7e5-fd5ea690d1f5" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "49afb1f4-6217-4e49-89c6-1b9cbc2ac459" - } - }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "6d7e5f06-5896-41a8-a821-0c7be723346d" - } - }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", - "value": { - "type": "numeric", - "guid": "5a24343c-5ec1-407e-b7e5-fd5ea690d1f5" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "49afb1f4-6217-4e49-89c6-1b9cbc2ac459" - } - }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "6d7e5f06-5896-41a8-a821-0c7be723346d" - } - }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", - "value": { - "type": "numeric", - "guid": "5a24343c-5ec1-407e-b7e5-fd5ea690d1f5" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Update numeric parameter value", - "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Strain 0.1 (Updated)", - "guid": "49afb1f4-6217-4e49-89c6-1b9cbc2ac459" - } - }, - "Example 2": { - "summary": "Update discrete parameter value", - "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Mean (Updated)", - "guid": "6d7e5f06-5896-41a8-a821-0c7be723346d" - } - }, - "Example 3": { - "summary": "Change guid of numeric", - "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", - "value": { - "type": "numeric", - "guid": "5a24343c-5ec1-407e-b7e5-fd5ea690d1f5" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "example": { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - } - } - } - }, - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValueUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Name already exists.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update the 'A-basis' parameter value with GUID '505b5d32-0a4a-48af-9a7a-90c4caacd35c' on 'Basis' parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'. The name was set to 'Mean', which is invalid because there is already a parameter value with that name on this parameter.", - "value": { - "message": "Cannot update parameter value with GUID '505b5d32-0a4a-48af-9a7a-90c4caacd35c' on parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'.", - "code": "parameterValueUpdate", - "parameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f", - "errors": [ - { - "message": "The parameter value name or GUID is not valid.", - "errors": [ - { - "message": "ParameterValue with name 'Mean' already exists in this Parameter.", - "name": "Mean", - "parentEntityType": "parameter", - "reason": "nameAlreadyExists", - "entityType": "parameterValue" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Multiple validation errors for updating a numeric parameter value", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update Batch Size 1000 parameter value with GUID '00000010-000b-4fff-8fff-0010ffff0000' on 'Batch Size' parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'. The name was set to 'Batch size A ', which is invalid because it has trailing white space. The parameter value was set to be negative, which is invalid because the parameter scaleType is 'logarithmic'. For a log-scale parameter, all values must be greater than zero.", - "value": { - "message": "Cannot update parameter value with GUID '00000010-000b-4fff-8fff-0010ffff0000' on parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterValueUpdate", - "parameterValueGuid": "00000010-000b-4fff-8fff-0010ffff0000", - "parameterGuid": "00000010-000a-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "For a log-scale parameter, all values must be greater than zero.", - "reason": "logScaleNegative" - }, - { - "message": "Parameter value name cannot contain leading or trailing whitespace.", - "name": "Batch size A ", - "reason": "nameWhitespace" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "UpdateNumericParameterValue: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, parameter or parameter value not found" - } - } - }, - "delete": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Delete a parameter value.", - "operationId": "DeleteParameterValue", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } }, { - "name": "parameter-guid", + "name": "section-guid", "in": "path", "required": true, "schema": { @@ -63753,786 +41036,680 @@ } }, { - "name": "parameter-value-guid", - "in": "path", - "required": true, + "name": "showFullDetail", + "in": "query", "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "400": { - "description": "Bad request. Parameter in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValueDeletionException" - }, - "example": { - "message": "Cannot delete parameter value with GUID '21a27377-12eb-413c-bac4-d4ffceda39d1'.", - "code": "deletion", - "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1", - "errors": [ - { - "message": "It is being used as the parameter default value.", - "reason": "usage", - "referencedByType": "defaultParameterValue", - "referencedBy": [ - { - "name": "Basis", - "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" - } - ] - }, - { - "message": "It is being used by multi-valued point data.", - "reason": "usage", - "referencedByType": "multiValuedPointData" - } - ] - } - } + "type": "boolean" } }, - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database, parameter or parameter value not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values": { - "post": { - "tags": [ - "Schema - Parameters" - ], - "summary": "Create a new parameter value.", - "operationId": "CreateParameterValue", - "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "enum": [ + "read", + "write" + ], + "type": "string" } }, { - "name": "parameter-guid", - "in": "path", - "required": true, + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", "schema": { - "type": "string", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" - } - }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" - } - }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" - } - }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateParameterValue" - }, - "examples": { - "Example 1": { - "summary": "Numeric parameter value", - "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "value": 10.0, - "type": "numeric", - "name": "Cold" - } - }, - "Example 2": { - "summary": "Discrete parameter value", - "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", - "value": { - "type": "discrete", - "name": "Heavy water" - } - } - } - } - } - }, "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaParameterValue" - }, - "example": { - "type": "numeric", - "value": 0.1, - "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" - } - } - } - }, - "400": { - "description": "Bad request. Parameter in use.", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaParameterValueCreationException" + "$ref": "#/components/schemas/GsaLayoutSection" }, "examples": { "Example 1": { - "summary": "Parameter value type does not match the type of the parameter.", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a numeric parameter value with name 'A New Basis' on discrete parameter 'Basis' with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'. Discrete parameters cannot have numeric parameter values.", + "summary": "Get 'slim' layout section", + "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to false, which is the default value.", "value": { - "message": "Cannot create parameter value 'A New Basis' on parameter with GUID '7a6ccb7b-8a47-4cab-8203-c741d476560f'.", - "code": "parameterValueCreation", - "name": "A New Basis", - "parameterGuid": "7a6ccb7b-8a47-4cab-8203-c741d476560f", - "errors": [ - { - "message": "Discrete parameters cannot have numeric parameter values.", - "parameterType": "discrete", - "reason": "parameterValueType" - } - ] + "detailType": "slim", + "displayNames": { + "de": "Testing Information German Display Name", + "fr": "Testing Information French Display Name" + }, + "name": "Testing Information", + "guid": "0d079e92-cc87-4ef2-a551-b6f4c2bf6132" } }, "Example 2": { - "summary": "Multiple validation errors for creating a numeric parameter value", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a numeric parameter value with name 'Batch size A ' on parameter 'Batch Size' with GUID '00000010-000a-4fff-8fff-0000ffff0000'. The name was set to 'Batch size A ', which is invalid because it has trailing white space. The parameter value was set to be negative, which is invalid because the parameter scaleType is 'logarithmic'. For a log-scale parameter, all values must be greater than zero.", + "summary": "Get 'full' layout section", + "description": "This example demonstrates the response to getting a layout section with the 'showFullDetail' parameter set to true.", "value": { - "message": "Cannot create parameter value 'Minimum' on parameter with GUID '00000010-000a-4fff-8fff-0000ffff0000'.", - "code": "parameterValueCreation", - "name": "Minimum", - "parameterGuid": "00000010-000a-4fff-8fff-0000ffff0000", - "errors": [ + "detailType": "full", + "sectionItems": [ { - "message": "The parameter value name or GUID is not valid.", - "errors": [ + "itemType": "attribute", + "attributeType": "shortText", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "daeb37ff-4ed6-4138-9e49-52d25094151a", + "name": "Form", + "guid": "4ae13e38-73f6-4d5a-980c-779174d03061" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [ + { + "itemType": "attribute", + "attributeType": "longText", + "required": true, + "readOnly": false, + "underlyingEntityGuid": "63995dd8-fa45-4411-bfa6-bfbecca7bd44", + "name": "Sources", + "guid": "9b229dee-e839-4ebc-9599-3f2408d0875f" + }, + { + "itemType": "attribute", + "attributeType": "shortText", + "required": true, + "readOnly": false, + "underlyingEntityGuid": "97df6ce2-03e0-4dbf-b83f-69d1de9a8e48", + "name": "Notes", + "guid": "25bf65ab-cb95-43f8-a364-2b33ef4d8e8f" + } + ], + "underlyingEntityGuid": "091d5472-a1ba-4053-902e-7d22ee7154b8", + "name": "Chemical resistance", + "guid": "39efe79c-77f0-4b19-9455-49370bd2a124" + }, + { + "itemType": "link", + "linkType": "recordLink", + "targetDatabase": "22142c50-df2e-4538-b15f-04125d0a06c9", + "targetDatabaseVersion": "f152a23e-fd94-49e7-bcab-bc514b13b670", + "targetTable": "beb4a67d-b448-4a6d-8bfb-801f0d34437a", + "forwards": true, + "underlyingEntityGuid": "a6e05677-6a80-4ea9-95cd-a9d299180df0", + "name": "Material Pedigree", + "guid": "0b5f30b8-63a1-4721-ba1e-c1c7ec6c25f5" + }, + { + "itemType": "attribute", + "attributeType": "link", + "required": false, + "readOnly": false, + "metaAttributes": [], + "tabularColumns": [ + { + "columnType": "linkedAttribute", + "tabularColumnGuid": "3909f42c-12bc-4eab-b520-fc9aa8d1f715", + "name": "Offset Yield Stress", + "guid": "f97bb94a-422b-405a-9421-ff7497347f15" + }, { - "message": "ParameterValue with name 'Minimum' already exists in this Parameter.", - "name": "Minimum", - "parentEntityType": "parameter", - "reason": "nameAlreadyExists", - "entityType": "parameterValue" + "columnType": "localShortText", + "tabularColumnGuid": "d1b1ab03-bcc5-4403-b059-5afbdcc28ce3", + "name": "Young's Modulus Notes", + "guid": "a4841455-103d-4304-a075-592cea07fa38" } ], - "reason": "namedEntity" + "underlyingEntityGuid": "3a715370-43b1-42c0-9057-3f2ddc3ee8e9", + "name": "Reference Characteristics", + "guid": "4a462aa7-fbae-48a0-b841-793ebeacef67" }, { - "message": "For a log-scale parameter, all values must be greater than zero.", - "reason": "logScaleNegative" + "itemType": "link", + "linkType": "associationChain", + "targetDatabase": "22142c50-df2e-4538-b15f-04125d0a06c9", + "targetDatabaseVersion": "f152a23e-fd94-49e7-bcab-bc514b13b670", + "targetTable": "d73fb8c3-2269-42c4-acc8-35e518016006", + "forwards": true, + "nextLink": { + "itemType": "link", + "linkType": "associationChain", + "targetDatabase": "22142c50-df2e-4538-b15f-04125d0a06c9", + "targetDatabaseVersion": "f152a23e-fd94-49e7-bcab-bc514b13b670", + "targetTable": "9dfec715-90f2-4bec-a662-fd607e87f10d", + "forwards": false, + "underlyingEntityGuid": "f77799b6-9c82-4319-bc7c-f200f8e582c1", + "name": "Pedigree information", + "guid": "0a6e0653-cc52-4195-915d-c091b2389791" + }, + "underlyingEntityGuid": "d966a89a-4eeb-4ce7-8625-4bfc570fd991", + "name": "To Pedigree from Producers", + "guid": "09bd9986-d17c-496a-a4c8-59c8b7c2104d" } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateNumericParameterValue: Required property 'name' not found in JSON", - "code": "jsonSerialization" + ], + "displayNames": { + "de": "Testing Information German Display Name", + "fr": "Testing Information French Display Name" + }, + "name": "Testing Information", + "guid": "464ec786-6046-4813-a2e2-ceb9b03e4d48" } } } } } }, - "403": { - "description": "Forbidden." - }, "404": { - "description": "Database or parameter not found" + "description": "Database, table, layout or layout section not found" } } - } - }, - "/v1alpha/profiles": { - "get": { + }, + "delete": { "tags": [ - "Schema - Profiles" + "Schema - Layout Sections" + ], + "summary": "Delete a layout section.", + "operationId": "DeleteSection", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Get AllProfilesInfo", - "operationId": "GetProfiles", "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAllProfilesInfo" - }, - "example": { - "profiles": [ - { - "key": "MI_Training", - "isImplicit": true, - "name": "MI Training" - }, - { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - }, - { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Composites" - }, - { - "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Additive Manufacturing" - } - ], - "defaultProfile": { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - } - } - } - } + "description": "Ok" + }, + "400": { + "description": "Bad request" }, "403": { "description": "Forbidden" + }, + "404": { + "description": "Database, table, layout or layout section not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items": { + "post": { "tags": [ - "Schema - Profiles" + "Schema - Layout Sections" + ], + "summary": "Add a new layout item.", + "operationId": "CreateLayoutItem", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } ], - "summary": "Update AllProfilesInfo", - "operationId": "UpdateAllProfilesInfo", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "defaultProfile": null + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false } ] } }, "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", - "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" - }, - "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", - "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", - "value": { - "defaultProfile": null - } - }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" ] } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", - "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" - }, - "examples": { - "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" } }, - "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "defaultProfile": null + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" } }, - "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ] + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "aeace992-831e-4a81-bc0d-0cab1f2b7c19", + "sourceTableGuid": "3abd916e-5853-428e-8e42-e1643153e2a2", + "linkGroupGuid": "84c5f8b8-4503-416b-8812-2d6574deb5f5" } }, - "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + "forwards": true, + "sourceDatabaseVersionGuid": "cf41cb1c-8d3c-42bb-b7b1-f869d6450761", + "tabularAttributeGuid": "ff2a7b19-0a90-43a9-8ea4-bdff7209c32c" }, { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "forwards": false, + "sourceDatabaseVersionGuid": "88342237-e37b-4deb-895b-787286af9f41", + "tabularAttributeGuid": "a9727622-a503-4871-a258-8c23f2c1cef6" } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + ] } } } }, - "application/*+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Update default profile", - "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Remove default profile", - "description": "This example demonstrates how to remove default profile by setting it to null", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "defaultProfile": null + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Update profiles order", - "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false } ] } }, "Example 4": { - "summary": "Everything for AllProfilesInfo", - "description": "This example shows all properties that can be updated for AllProfilesInfo.", + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "profiles": [ - { - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" - }, - { - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" - }, - { - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" - } - ], - "defaultProfile": { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" - } + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] } - } - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAllProfilesInfo" }, - "example": { - "profiles": [ - { - "key": "MI_Training", - "isImplicit": true, - "name": "MI Training" - }, - { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - }, - { - "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", - "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Composites" - }, - { - "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", - "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Additive Manufacturing" - } - ], - "defaultProfile": { - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" - } - } - } - } - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - }, - "post": { - "tags": [ - "Schema - Profiles" - ], - "summary": "Create a new profile", - "operationId": "CreateProfile", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "MI:Training Processes" + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "MI:Training Processes", - "guid": "e951f8e7-fd5b-4203-83d4-6cbc5ccff37e" + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "f9207447-f5d3-4fee-a4c9-162a9398488d" + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "aeace992-831e-4a81-bc0d-0cab1f2b7c19", + "sourceTableGuid": "3abd916e-5853-428e-8e42-e1643153e2a2", + "linkGroupGuid": "84c5f8b8-4503-416b-8812-2d6574deb5f5" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "cf41cb1c-8d3c-42bb-b7b1-f869d6450761", + "tabularAttributeGuid": "ff2a7b19-0a90-43a9-8ea4-bdff7209c32c" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "88342237-e37b-4deb-895b-787286af9f41", + "tabularAttributeGuid": "a9727622-a503-4871-a258-8c23f2c1cef6" + } + ] } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "name": "MI:Training Processes" + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "name": "MI:Training Processes", - "guid": "e951f8e7-fd5b-4203-83d4-6cbc5ccff37e" + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "f9207447-f5d3-4fee-a4c9-162a9398488d" + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" - }, - "examples": { - "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + }, + "Example 4": { + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", "value": { - "name": "MI:Training Processes" + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] } }, - "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "name": "MI:Training Processes", - "guid": "e951f8e7-fd5b-4203-83d4-6cbc5ccff37e" + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" } }, - "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "f9207447-f5d3-4fee-a4c9-162a9398488d" + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "aeace992-831e-4a81-bc0d-0cab1f2b7c19", + "sourceTableGuid": "3abd916e-5853-428e-8e42-e1643153e2a2", + "linkGroupGuid": "84c5f8b8-4503-416b-8812-2d6574deb5f5" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "cf41cb1c-8d3c-42bb-b7b1-f869d6450761", + "tabularAttributeGuid": "ff2a7b19-0a90-43a9-8ea4-bdff7209c32c" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "88342237-e37b-4deb-895b-787286af9f41", + "tabularAttributeGuid": "a9727622-a503-4871-a258-8c23f2c1cef6" + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfile" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, "examples": { "Example 1": { - "summary": "Profile", - "description": "This example demonstrates how to create a new profile", + "summary": "Layout Attribute Item", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. The ReadOnly and Required properties default to false.", "value": { - "name": "MI:Training Processes" + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b" } }, "Example 2": { - "summary": "Profile with specified guid", - "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Layout Attribute Item with ReadOnly and Required properties set", + "description": "This example demonstrates how to add the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database specifying the ReadOnly and Required properties and the Guid of the created layout item.", "value": { - "name": "MI:Training Processes", - "guid": "e951f8e7-fd5b-4203-83d4-6cbc5ccff37e" + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": true } }, "Example 3": { - "summary": "Full profile", - "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates how to add the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "description": "#markdown\r\nFor process-oriented users.", - "homepageUrl": "TrainingProfiles/TrainingProcesses", - "groupName": "MI:Training Profiles", - "name": "MI:Training Processes", - "guid": "f9207447-f5d3-4fee-a4c9-162a9398488d" + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": false, + "readOnly": false + } + ] + } + }, + "Example 4": { + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates how to add the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include.", + "value": { + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ] + } + }, + "Example 5": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates how to add the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + } + }, + "Example 6": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates how to add the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + } + }, + "Example 7": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates how to add a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "aeace992-831e-4a81-bc0d-0cab1f2b7c19", + "sourceTableGuid": "3abd916e-5853-428e-8e42-e1643153e2a2", + "linkGroupGuid": "84c5f8b8-4503-416b-8812-2d6574deb5f5" + } + }, + "Example 8": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates how to add an association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "cf41cb1c-8d3c-42bb-b7b1-f869d6450761", + "tabularAttributeGuid": "ff2a7b19-0a90-43a9-8ea4-bdff7209c32c" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "88342237-e37b-4deb-895b-787286af9f41", + "tabularAttributeGuid": "a9727622-a503-4871-a258-8c23f2c1cef6" + } + ] } } } @@ -64545,32 +41722,110 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfile" + "$ref": "#/components/schemas/GsaNewLayoutItem" }, - "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" + "examples": { + "Example 1": { + "summary": "Layout Attribute Item", + "description": "This example demonstrates the response to creating a new attribute layout item. It was created by adding the 'Additive' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "attribute", + "attributeGuid": "ec51581f-4a78-4b1b-81df-83382c541b7b", + "required": true, + "readOnly": false, + "metaAttributes": null, + "tabularColumnGuids": null, + "guid": "5772e84d-02f7-4430-b09e-8bbe141397a9" } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" + }, + "Example 2": { + "summary": "Layout Attribute Item with Meta Attributes", + "description": "This example demonstrates the response to creating a new attribute layout item with a meta-attribute. It was created by adding the 'Flexural modulus' attribute with its 'Notes' meta-attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "attribute", + "attributeGuid": "000000ec-0001-4fff-8fff-dd92ffff0000", + "required": false, + "readOnly": false, + "metaAttributes": [ + { + "itemType": "attribute", + "attributeGuid": "3cd6866c-3ad4-4cc9-b2d0-e7296b0c12d5", + "required": true, + "readOnly": false + } + ], + "tabularColumnGuids": null, + "guid": "5e240fc9-015e-471e-af8a-7a4a302afdb3" + } + }, + "Example 3": { + "summary": "Layout Attribute Item for a Tabular Attribute", + "description": "This example demonstrates the response to creating a new tabular attribute layout item with specified tabular columns to include. It was created by adding the 'Restricted substances associated with this material' attribute to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified tabular columns to include. ", + "value": { + "itemType": "attribute", + "attributeGuid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554", + "required": false, + "readOnly": false, + "metaAttributes": null, + "tabularColumnGuids": [ + "7b28a5fd-4972-40fc-8181-626586258bc3", + "9a0ce77a-60cf-42c7-b827-e7d74bea7a6b" + ], + "guid": null + } + }, + "Example 4": { + "summary": "Layout Record Link Group Item", + "description": "This example demonstrates the response to creating a new link group layout item. It was created by adding the 'MaterialUniverse' (reverse name 'Training Exercise') link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "recordLink", + "forwards": null, + "linkGroupGuid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949", + "guid": null + } + }, + "Example 5": { + "summary": "Layout Smart Link Group Item", + "description": "This example demonstrates the response to creating a new smart link group layout item. It was created by adding the 'Smart Link to Training Record' smart link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "smartLink", + "forwards": true, + "linkGroupGuid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66", + "guid": null + } + }, + "Example 6": { + "summary": "Layout Cross Database Link Group Item", + "description": "This example demonstrates the response to creating a new cross database link group layout item. It was created by adding a cross database link group to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "crossDatabaseLink", + "sourceDatabaseGuid": "981768c5-80ed-4132-8747-6dc47559822f", + "sourceTableGuid": "002561e5-b03f-4f37-9162-a0671a8afac3", + "linkGroupGuid": "345d5342-0c25-4b26-a4ee-84701278c67e", + "guid": null + } + }, + "Example 7": { + "summary": "Layout Association Chain Item", + "description": "This example demonstrates the response to creating a new association chain layout item. It was created by adding a association chain to the 'General Properties' layout section (guid = b10170ab-ff56-4828-81b8-c4427674ed2f) of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "itemType": "associationChain", + "associationChainName": "Name of association chain", + "associationChainLinks": [ + { + "forwards": true, + "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", + "tabularAttributeGuid": "b0dbe40f-466e-4bd0-aaf3-44ba6d59513b" + }, + { + "forwards": false, + "sourceDatabaseVersionGuid": "00000000-0000-0000-0000-000000000000", + "tabularAttributeGuid": "072f8c71-9502-4131-a70e-44261597ceec" + } + ], + "guid": null + } + } } } } @@ -64580,26 +41835,140 @@ }, "403": { "description": "Forbidden" + }, + "404": { + "description": "Database, table, layout or layout section not found" } } } }, - "/v1alpha/profiles/{profile-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}/sections/{section-guid}/items/{item-guid}": { + "delete": { + "tags": [ + "Schema - Layout Sections" + ], + "summary": "Delete a layout item.", + "operationId": "DeleteItem", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "section-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "item-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table, layout, layout section or layout section item not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts": { "get": { "tags": [ - "Schema - Profiles" + "Schema - Layouts" ], - "summary": "Get individual profile", - "operationId": "GetProfile", + "summary": "Get all layouts for table", + "operationId": "GetLayouts", "parameters": [ { - "name": "profile-guid", + "name": "database-key", + "in": "path", + "description": "", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", + "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "application", + "in": "query", + "description": "Optionally filter by application that the layout is applicable to.", + "schema": { + "type": "string" + } } ], "responses": { @@ -64608,53 +41977,55 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfile" + "$ref": "#/components/schemas/GsaLayoutsInfo" }, "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ + "layouts": [ { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" }, { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" + "displayNames": {}, + "name": "Metals", + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Polymers", + "guid": "00007645-0009-4fff-8fff-dd92ffff0000" + } + ] } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Profile not found" + "description": "Database or table not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Profiles" + "Schema - Layouts" ], - "summary": "Update a profile", - "operationId": "UpdateProfile", + "summary": "Create a new layout.", + "operationId": "CreateLayout", "parameters": [ { - "name": "profile-guid", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -64667,144 +42038,132 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "eb530140-9529-4cff-af57-7480679cc7c9" + "name": "Composite materials" } }, "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "MI:Training Metals (Updated)" + "name": "Composite materials (guid)", + "guid": "ab07aed3-b9da-4037-a02c-02e311fa9e53" } }, "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + "applicableApplications": [ + "MI:Explore", + "An Application" ], - "guid": "4dcc7b12-1dfc-4555-ae36-18db06601374", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "name": "Composite materials (with applicable applications)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "eb530140-9529-4cff-af57-7480679cc7c9" + "name": "Composite materials" } }, "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "MI:Training Metals (Updated)" + "name": "Composite materials (guid)", + "guid": "ab07aed3-b9da-4037-a02c-02e311fa9e53" } }, "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + "applicableApplications": [ + "MI:Explore", + "An Application" ], - "guid": "4dcc7b12-1dfc-4555-ae36-18db06601374", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "name": "Composite materials (with applicable applications)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "eb530140-9529-4cff-af57-7480679cc7c9" + "name": "Composite materials" } }, "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "MI:Training Metals (Updated)" + "name": "Composite materials (guid)", + "guid": "ab07aed3-b9da-4037-a02c-02e311fa9e53" } }, "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + "applicableApplications": [ + "MI:Explore", + "An Application" ], - "guid": "4dcc7b12-1dfc-4555-ae36-18db06601374", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "name": "Composite materials (with applicable applications)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfile" + "$ref": "#/components/schemas/GsaCreateLayout" }, "examples": { "Example 1": { - "summary": "Update a guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "eb530140-9529-4cff-af57-7480679cc7c9" + "name": "Composite materials" } }, "Example 2": { - "summary": "Update a name", - "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Layout with Guid", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with a specified guid value. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "name": "MI:Training Metals (Updated)" + "name": "Composite materials (guid)", + "guid": "ab07aed3-b9da-4037-a02c-02e311fa9e53" } }, "Example 3": { - "summary": "Everything for a profile", - "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", + "summary": "Layout with applicable applications", + "description": "This example demonstrates how to create a new layout for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with specified applicable applications. If no applicable applications are set, the layout is always applicable.", "value": { - "description": "#markdown\r\nFor metals-oriented users. (Updated)", - "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", - "profileTableGuids": [ - "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + "applicableApplications": [ + "MI:Explore", + "An Application" ], - "guid": "4dcc7b12-1dfc-4555-ae36-18db06601374", - "groupName": "MI:Training Profiles (Updated)", - "name": "MI:Training Metals" + "name": "Composite materials (with applicable applications)" } } } @@ -64812,37 +42171,18 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfile" + "$ref": "#/components/schemas/GsaLayout" }, "example": { - "description": "#markdown\r\nFor metals-oriented users.", - "homepageUrl": "TrainingProfiles/MITrainingMetals", - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" - } - ], - "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", - "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", - "groupName": "MI:Training Profiles", - "isImplicit": false, - "name": "MI:Training Metals" + "applicableApplications": [], + "displayNames": {}, + "name": "Ceramics", + "guid": "16206a94-8034-45a1-b6e5-aee4a87d2abe" } } } @@ -64854,59 +42194,75 @@ "description": "Forbidden" }, "404": { - "description": "Profile not found" + "description": "Database or table not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts/{layout-guid}": { + "get": { "tags": [ - "Schema - Profiles" + "Schema - Layouts" ], - "summary": "Delete a profile", - "operationId": "DeleteProfile", + "summary": "Get a layout with a specified guid for a given database and table.", + "operationId": "GetLayout", "parameters": [ { - "name": "profile-guid", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request. Profile is set as default." }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile not found" - } - } - } - }, - "/v1alpha/profiles/{profile-guid}/profile-tables": { - "get": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Get all profile tables of given profile", - "operationId": "GetProfileTables", - "parameters": [ { - "name": "profile-guid", + "name": "layout-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "showFullDetail", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } } ], "responses": { @@ -64915,46 +42271,164 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfileTablesInfo" + "$ref": "#/components/schemas/GsaLayout" }, - "example": { - "profileTables": [ - { - "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "MaterialUniverse" - }, - { - "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "ProcessUniverse" + "examples": { + "Example 1": { + "summary": "Layout with 'slim' sections", + "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to false, which is the default value.", + "value": { + "sections": [ + { + "sectionDetailType": "slim", + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "slim", + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + } + ], + "applicableApplications": [], + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" } - ] + }, + "Example 2": { + "summary": "Layout with 'full' sections", + "description": "This example demonstrated the response to getting a layout with the 'showFullDetail' parameter set to true.", + "value": { + "sections": [ + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "d14a9d30-b58c-4f71-987a-e70eedf28ea9", + "name": "Price", + "guid": "642d4df9-f165-4611-9fa1-bd8b58877504" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": false, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "3eddf0c3-ecef-4e94-a854-20df5dd185ec", + "name": "Density", + "guid": "50eb6515-24d7-4496-ae5c-b314d3140ea4" + } + ], + "displayNames": { + "en": "General Properties English Display Name", + "fr": "General Properties French Display Name" + }, + "name": "General Properties", + "guid": "b10170ab-ff56-4828-81b8-c4427674ed2f" + }, + { + "sectionDetailType": "full", + "sectionItems": [ + { + "itemType": "attribute", + "attributeType": "floatFunctional", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "23bcb60f-fc1a-40cf-b225-76603b459e9c", + "name": "Young's modulus", + "guid": "fcf57ce7-c792-40af-ad8c-3b14cfc3f2eb" + }, + { + "itemType": "attribute", + "attributeType": "range", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "3a35901d-5c14-479a-b814-d97366718e66", + "name": "Tensile strength", + "guid": "882d624a-c2bf-4806-ae65-dd5cdabf4777" + }, + { + "itemType": "attribute", + "attributeType": "point", + "required": true, + "readOnly": false, + "metaAttributes": [], + "underlyingEntityGuid": "ecb0acab-52db-4f4d-8cb9-22c8bdf221a6", + "name": "Shape factor", + "guid": "7f2abe22-a760-40a1-a38a-d7225592d0dc" + } + ], + "displayNames": { + "en": "Mechanical Properties English Display Name", + "fr": "Mechanical Properties French Display Name" + }, + "name": "Mechanical Properties", + "guid": "aa6a7ef2-0e37-40a6-b3eb-11d502408281" + } + ], + "applicableApplications": [], + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Profile not found" + "description": "Database, table or layout not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - ProfileTables" + "Schema - Layouts" ], - "summary": "Create a new profile table", - "operationId": "CreateProfileTable", + "summary": "Update a layout.", + "operationId": "UpdateLayout", "parameters": [ { - "name": "profile-guid", + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", "in": "path", "required": true, "schema": { @@ -64967,140 +42441,132 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "eb5ff4f4-436f-4693-bf06-b83aa40dc5d4" } }, "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "6f84ac27-af16-4fe0-b518-c897ca778903" + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "22e01d1c-3a8d-41f2-b75b-4ed463ef58b5" + "applicableApplications": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "eb5ff4f4-436f-4693-bf06-b83aa40dc5d4" } }, "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "6f84ac27-af16-4fe0-b518-c897ca778903" + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "22e01d1c-3a8d-41f2-b75b-4ed463ef58b5" + "applicableApplications": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "eb5ff4f4-436f-4693-bf06-b83aa40dc5d4" } }, "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "6f84ac27-af16-4fe0-b518-c897ca778903" + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "22e01d1c-3a8d-41f2-b75b-4ed463ef58b5" + "applicableApplications": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateProfileTable" + "$ref": "#/components/schemas/GsaUpdateLayout" }, "examples": { "Example 1": { - "summary": "Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "summary": "Everything for a layout", + "description": "This example demonstrates how to update all properties of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + "applicableApplications": [ + "MI:Explore", + "An Application" + ], + "name": "Ceramics (Updated)", + "guid": "eb5ff4f4-436f-4693-bf06-b83aa40dc5d4" } }, "Example 2": { - "summary": "Profile Table with specified guid", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Rename layout", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "guid": "6f84ac27-af16-4fe0-b518-c897ca778903" + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Full Profile Table", - "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "summary": "Remove applicable applications from layout", + "description": "This example demonstrates how to remove any applicable applications from the 'Ceramics' layout (guid = 00000b36-0009-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", - "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", - "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", - "guid": "22e01d1c-3a8d-41f2-b75b-4ed463ef58b5" + "applicableApplications": null } } } @@ -65108,23 +42574,18 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfileTable" + "$ref": "#/components/schemas/GsaLayout" }, "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" + "applicableApplications": [], + "displayNames": {}, + "name": "Ceramics", + "guid": "b68fc025-9a25-4f37-b19d-9bb9a2224d3a" } } } @@ -65136,30 +42597,78 @@ "description": "Forbidden" }, "404": { - "description": "Profile not found" + "description": "Database, table or layout not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Layouts" + ], + "summary": "Delete a layout.", + "operationId": "DeleteLayout", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "layout-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or layout not found" } } } }, - "/v1alpha/profiles/{profile-guid}/profile-tables/{profile-table-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/layouts:applications": { "get": { "tags": [ - "Schema - ProfileTables" + "Schema - Layouts" ], - "summary": "Get individual profile table", - "operationId": "GetProfileTable", + "summary": "Returns applications that are either MI Applications, or in use in layouts in this table.\r\nCan be used as applicable applications for layouts.", + "operationId": "Applications", "parameters": [ { - "name": "profile-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } }, { - "name": "profile-table-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -65174,18 +42683,15 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfileTable" + "$ref": "#/components/schemas/GsaApplicationsInfo" }, "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" + "applications": [ + "MI:Viewer", + "MI:Explore", + "MI:Materials Gateway", + "An Application" + ] } } } @@ -65194,33 +42700,151 @@ "description": "Forbidden" }, "404": { - "description": "Profile or profile table not found" + "description": "Database or table not found" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/parameters": { + "get": { "tags": [ - "Schema - ProfileTables" + "Schema - Parameters" ], - "summary": "Update a profile table", - "operationId": "UpdateProfileTable", + "summary": "Get all parameters for a given database.", + "operationId": "GetParameters", "parameters": [ { - "name": "profile-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParametersInfo" + }, + "examples": { + "Example 1": { + "summary": "A mix of parameters", + "description": "This example contains a mix of numeric and discrete parameters from the MI_Training database.", + "value": { + "parameters": [ + { + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "numeric", + "isRestricted": false, + "values": [ + { + "type": "numeric", + "value": -1.0, + "guid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94" + }, + { + "type": "numeric", + "value": 0.0, + "guid": "00000022-000b-4fff-8fff-0022ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/strain-ratio.html", + "defaultParameterValueGuid": "4c35e5cd-0641-45d1-96d3-bc42076b3a94", + "displayNames": { + "en": "Strain Ratio", + "fr": "Rapport de contrainte" + }, + "name": "Strain Ratio", + "guid": "00000022-000a-4fff-8fff-0000ffff0000" + }, + { + "type": "discrete", + "values": [ + { + "type": "discrete", + "name": "Mean", + "guid": "21a27377-12eb-413c-bac4-d4ffceda39d1" + }, + { + "type": "discrete", + "name": "A-basis", + "guid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c" + }, + { + "type": "discrete", + "name": "B-basis", + "guid": "9ba94816-6784-4848-bfa6-d24b12597a5b" + } + ], + "helpPath": "/help/basis.html", + "defaultParameterValueGuid": "21a27377-12eb-413c-bac4-d4ffceda39d1", + "displayNames": { + "en": "Basis", + "fr": "Base" + }, + "name": "Basis", + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + } + } + } } }, + "404": { + "description": "Database not found" + } + } + }, + "post": { + "tags": [ + "Schema - Parameters" + ], + "summary": "Create a new parameter.", + "operationId": "CreateParameter", + "parameters": [ { - "name": "profile-table-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -65228,124 +42852,552 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "9551e39f-68e3-4b7e-844d-30cf40dfdb85" + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" } }, "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", "value": { - "subsetGuid": null, - "layoutGuid": null + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "42ec6c73-efc1-4887-8fec-c2233fcb3180" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "c76438ce-0795-430c-a4a3-e6a367f78e90" } }, "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", + "value": { + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameter" + }, + "examples": { + "Example 1": { + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" + } + }, + "Example 2": { + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", + "value": { + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "42ec6c73-efc1-4887-8fec-c2233fcb3180" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "c76438ce-0795-430c-a4a3-e6a367f78e90" + } + }, + "Example 3": { + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", "value": { - "guid": "d2507490-4bc0-42a2-9bda-f1d6985dc451" + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" } } } }, - "application/json": { + "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "9551e39f-68e3-4b7e-844d-30cf40dfdb85" + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" } }, "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", "value": { - "subsetGuid": null, - "layoutGuid": null + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "42ec6c73-efc1-4887-8fec-c2233fcb3180" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "c76438ce-0795-430c-a4a3-e6a367f78e90" } }, "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", - "value": { - "guid": "d2507490-4bc0-42a2-9bda-f1d6985dc451" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" - }, - "examples": { - "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "9551e39f-68e3-4b7e-844d-30cf40dfdb85" + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" } }, - "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", "value": { - "subsetGuid": null, - "layoutGuid": null + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" } }, - "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", "value": { - "guid": "d2507490-4bc0-42a2-9bda-f1d6985dc451" + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateProfileTable" + "$ref": "#/components/schemas/GsaCreateParameter" }, "examples": { "Example 1": { - "summary": "Everything for a profile table", - "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter", + "description": "This example demonstrates how to create a new discrete parameter for the MI_Training database.", "value": { - "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "guid": "9551e39f-68e3-4b7e-844d-30cf40dfdb85" + "values": [ + { + "type": "discrete", + "name": "Red" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 0, + "name": "Color" } }, "Example 2": { - "summary": "Remove subset and layout", - "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Discrete Parameter with Guids", + "description": "This example demonstrates how to create a new discrete parameter with a specified guid value for the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. Guids can be explicitly set for the individual parameter values, if needed.", "value": { - "subsetGuid": null, - "layoutGuid": null + "values": [ + { + "type": "discrete", + "name": "Red", + "guid": "42ec6c73-efc1-4887-8fec-c2233fcb3180" + }, + { + "type": "discrete", + "name": "Green" + } + ], + "type": "discrete", + "defaultParameterValueIndex": 1, + "name": "Color (guid)", + "guid": "c76438ce-0795-430c-a4a3-e6a367f78e90" } }, "Example 3": { - "summary": "Just guid", - "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "summary": "Numeric Restricted Parameter", + "description": "This example demonstrates how to create a new numeric restricted parameter for the MI_Training database. Note that the IsRestricted flag is set to true.", + "value": { + "type": "numeric", + "isRestricted": true, + "values": [ + { + "value": 2010.0, + "type": "numeric", + "name": "Twenty Ten" + }, + { + "value": 2015.0, + "type": "numeric" + }, + { + "value": 2020.0, + "type": "numeric", + "name": "Twenty Twenty" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 2, + "name": "Year" + } + }, + "Example 4": { + "summary": "Numeric Restricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric restricted parameter which also has the 'centimetre' unit from the MI_Training database. Note that the IsRestricted flag is set to true. Only the unit guid is required to reference a unit.", + "value": { + "type": "numeric", + "isRestricted": true, + "unit": { + "guid": "00000099-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Small box" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Big box" + } + ], + "interpolationType": "none", + "scaleType": "linear", + "defaultParameterValueIndex": 0, + "name": "Box dimension" + } + }, + "Example 5": { + "summary": "Numeric Unrestricted Parameter with Unit", + "description": "This example demonstrates how to create a new numeric unrestricted parameter which also has the 'Temperature (Kelvin/Celsius)' unit from the MI_Training database. The IsRestricted flag can either be explicitly set to false or omitted. Pre-defined parameter values can still be specified, but the parameter will not be restricted to them.", "value": { - "guid": "d2507490-4bc0-42a2-9bda-f1d6985dc451" + "type": "numeric", + "isRestricted": false, + "unit": { + "guid": "00000002-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "value": 10.0, + "type": "numeric", + "name": "Cold" + }, + { + "value": 20.0, + "type": "numeric" + }, + { + "value": 30.0, + "type": "numeric", + "name": "Hot" + } + ], + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "/help/outside-temperature.html", + "defaultParameterValueIndex": 2, + "name": "Outside Temperature" } } } @@ -65353,23 +43405,42 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaProfileTable" + "$ref": "#/components/schemas/GsaParameter" }, "example": { - "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", - "subsetFallbackHint": "Metals", - "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", - "layoutFallbackHint": "Metals", - "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseFallbackHint": "MI:Training", - "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", - "tableFallbackHint": "Design Data" + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" } } } @@ -65380,274 +43451,36 @@ "403": { "description": "Forbidden" }, - "404": { - "description": "Profile or profile table not found" - } - } - }, - "delete": { - "tags": [ - "Schema - ProfileTables" - ], - "summary": "Delete a profile table", - "operationId": "DeleteProfileTable", - "parameters": [ - { - "name": "profile-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "profile-table-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Profile or profile table not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/quality-systems": { - "get": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Get all quality systems", - "operationId": "GetQualitySystems", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystemsInfo" - }, - "examples": { - "Example 1": { - "summary": "Quality Systems", - "description": "Example of quality systems from the MI Training database", - "value": { - "qualitySystems": [ - { - "type": "continuous", - "doesQualityIncreaseWithValue": true, - "thresholdValue": 5.0, - "name": "Test Numerical Quality system", - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" - }, - { - "type": "discrete", - "thresholdValue": { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - "qualityDiscreteValues": [ - { - "order": 1, - "name": "Poor", - "guid": "0f5a2257-a633-46e7-92b8-b504a8bdbb34" - }, - { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - { - "order": 3, - "name": "Good", - "guid": "dc966885-a72e-4370-ad48-3b7e45c5729f" - } - ], - "name": "Test Data Quality system", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } - ] - } - } - } - } - } - }, "404": { "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/quality-systems/{quality-system-guid}": { - "get": { - "tags": [ - "Schema - Quality Systems" - ], - "summary": "Get individual quality system", - "operationId": "GetQualitySystem", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "quality-system-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - "examples": { - "Example 1": { - "summary": "Continuous Quality system", - "description": "Example response for the 'Test Numerical Quality system' quality system from the MI Training database", - "value": { - "type": "continuous", - "doesQualityIncreaseWithValue": true, - "thresholdValue": 5.0, - "name": "Test Numerical Quality system", - "guid": "45c157d0-235f-423f-bb2b-6291bdad3940" - } - }, - "Example 2": { - "summary": "Discrete Quality system", - "description": "Example response for the 'Test Data Quality system' quality system from the MI Training database", - "value": { - "type": "discrete", - "thresholdValue": { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - "qualityDiscreteValues": [ - { - "order": 1, - "name": "Poor", - "guid": "0f5a2257-a633-46e7-92b8-b504a8bdbb34" - }, - { - "order": 2, - "name": "Satisfactory", - "guid": "255032f6-1fa5-4d27-8a2f-5e539a33cd5f" - }, - { - "order": 3, - "name": "Good", - "guid": "dc966885-a72e-4370-ad48-3b7e45c5729f" - } - ], - "name": "Test Data Quality system", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" - } - } - } - } - } - }, - "404": { - "description": "Database or quality system not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}": { "get": { "tags": [ - "Schema - Record Link Groups" + "Schema - Parameters" ], - "summary": "Get all record link groups pointing from this table.", - "operationId": "GetRecordLinkGroups", + "summary": "Get a parameter with a specified guid for a given database.", + "operationId": "GetParameter", "parameters": [ { "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "parameter-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -65656,136 +43489,67 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupsInfo" + "$ref": "#/components/schemas/GsaParameter" }, "example": { - "recordLinkGroups": [ - { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "identity": 115, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" - }, + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "identity": 3, - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" - }, - "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" - }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" }, { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "2df52c81-7f4e-459f-8533-1c8cc4e1ff96", - "tableGuid": "1bc74e96-a479-4eb6-bbb9-80ed5edce69b" - } - }, - "identity": 1, - "reverseName": "Second Training Database And Table - MI Training Exercise for Import", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "MI Training Exercise for Import - Second Training Database And Table", - "guid": "7a667f0b-f514-4966-a973-da9d7c8b640b" + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" } - ] + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" } } } }, "404": { - "description": "Database or table not found" + "description": "Database or parameter not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Record Link Groups" + "Schema - Parameters" ], - "summary": "Create a new record link group.", - "operationId": "CreateRecordLinkGroup", + "summary": "Update a parameter.", + "operationId": "UpdateParameter", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "parameter-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } @@ -65794,1198 +43558,1272 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "89007e15-3384-4aad-baab-4942f59ca8cb" } }, "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "411587ec-c669-453c-8548-d0fc83bf5a7b" + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "dffc4e35-b74f-41c8-b5bd-379697e9c2d5" } }, "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "b72f944a-25d1-4f08-93be-1f7cb30f7388" - }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "type": "numeric", + "guid": "d9f8dee7-9783-4c63-a5d6-3f772fdc4089" } }, "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "1cebdce4-da52-42eb-b6bd-fe8dd3c6ff72", - "tableGuid": "89a4a83d-dc59-4e16-a4bf-6b03f5c9f53d" - }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "010e58d8-e26d-42a8-a67b-f5590ba967a0" + "type": "discrete", + "name": "Strain (Updated)" } }, "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "guid": "e806900d-a5da-421c-9690-05c5a6744a6b" } }, "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" - }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "4a029e9b-0535-49c3-ba90-bbd2f7991e8b" + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "89007e15-3384-4aad-baab-4942f59ca8cb" } }, "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "411587ec-c669-453c-8548-d0fc83bf5a7b" + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "dffc4e35-b74f-41c8-b5bd-379697e9c2d5" } }, "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "b72f944a-25d1-4f08-93be-1f7cb30f7388" - }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "type": "numeric", + "guid": "d9f8dee7-9783-4c63-a5d6-3f772fdc4089" } }, "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "1cebdce4-da52-42eb-b6bd-fe8dd3c6ff72", - "tableGuid": "89a4a83d-dc59-4e16-a4bf-6b03f5c9f53d" - }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "010e58d8-e26d-42a8-a67b-f5590ba967a0" + "type": "discrete", + "name": "Strain (Updated)" } }, "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "guid": "e806900d-a5da-421c-9690-05c5a6744a6b" } }, "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" - }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "4a029e9b-0535-49c3-ba90-bbd2f7991e8b" + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "89007e15-3384-4aad-baab-4942f59ca8cb" } }, "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "411587ec-c669-453c-8548-d0fc83bf5a7b" + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "dffc4e35-b74f-41c8-b5bd-379697e9c2d5" } }, "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "b72f944a-25d1-4f08-93be-1f7cb30f7388" - }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "type": "numeric", + "guid": "d9f8dee7-9783-4c63-a5d6-3f772fdc4089" } }, "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "1cebdce4-da52-42eb-b6bd-fe8dd3c6ff72", - "tableGuid": "89a4a83d-dc59-4e16-a4bf-6b03f5c9f53d" - }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "010e58d8-e26d-42a8-a67b-f5590ba967a0" + "type": "discrete", + "name": "Strain (Updated)" } }, "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "guid": "e806900d-a5da-421c-9690-05c5a6744a6b" } }, "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" - }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "4a029e9b-0535-49c3-ba90-bbd2f7991e8b" + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateParameter" }, "examples": { "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", + "summary": "Everything for a numeric parameter", + "description": "This example shows how to update all properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "includeIndirectLinks": false, - "reverseName": "Material Universe static self link reversed", - "name": "Material Universe static self link" + "interpolationType": "cubicSpline", + "scaleType": "logarithmic", + "helpPath": "help/strain-updated.html", + "defaultParameterValueGuid": "173284fb-e557-406f-a7eb-f4e75f1d48a9", + "name": "Strain (Updated)", + "guid": "89007e15-3384-4aad-baab-4942f59ca8cb" } }, "Example 2": { - "summary": "Static record link group with specified guid", - "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Everything for a discrete parameter", + "description": "This example shows how to update all properties of the 'Basis' discrete parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", "value": { - "type": "static", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "includeIndirectLinks": true, - "reverseName": "Material Universe static link", - "name": "Process Universe static link", - "guid": "411587ec-c669-453c-8548-d0fc83bf5a7b" + "type": "discrete", + "helpPath": "help/basis-updated.html", + "defaultParameterValueGuid": "505b5d32-0a4a-48af-9a7a-90c4caacd35c", + "name": "Basis (Updated)", + "guid": "dffc4e35-b74f-41c8-b5bd-379697e9c2d5" } }, "Example 3": { - "summary": "Cross database record link group", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "summary": "Update Guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Guid can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "tableGuid": "b72f944a-25d1-4f08-93be-1f7cb30f7388" - }, - "includeIndirectLinks": false, - "reverseName": "Cross database link to Material Universe", - "name": "Cross database link from Material Universe" + "type": "numeric", + "guid": "d9f8dee7-9783-4c63-a5d6-3f772fdc4089" } }, "Example 4": { - "summary": "Cross database record link group with specified guid and target database guid", - "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", + "summary": "Update Name", + "description": "This example demonstrates how to update the 'Name' property of the 'Strain' parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Name can be updated for both kinds of parameters.", "value": { - "type": "crossDatabase", - "linkTarget": { - "databaseGuid": "1cebdce4-da52-42eb-b6bd-fe8dd3c6ff72", - "tableGuid": "89a4a83d-dc59-4e16-a4bf-6b03f5c9f53d" - }, - "includeIndirectLinks": true, - "reverseName": "Cross database link to MI Training - Material Universe", - "name": "Cross database link from MI Training - Material Universe", - "guid": "010e58d8-e26d-42a8-a67b-f5590ba967a0" + "type": "discrete", + "name": "Strain (Updated)" } }, "Example 5": { - "summary": "Smart record link group", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "summary": "Update Guid and Unit", + "description": "This example demonstrates how to update the 'Guid' and 'Unit' properties of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. Its Unit will be changed to kg. Only numeric parameters have units.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "type": "numeric", + "unit": { + "guid": "0000007a-0013-4fff-8fff-0000ffff0000" }, - "forbidOrphans": false, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" - } - ], - "reverseName": "Material Universe smart self link reversed", - "name": "Material Universe smart self link" + "guid": "e806900d-a5da-421c-9690-05c5a6744a6b" } }, "Example 6": { - "summary": "Smart record link group with all fields specified", - "description": "This example demonstrates how to create a new smart record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", + "summary": "Remove Unit", + "description": "This example demonstrates how to remove the 'Unit' property of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database by setting it to null.", "value": { - "type": "smart", - "linkTarget": { - "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" - }, - "forbidOrphans": true, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", - "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" - }, - { - "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", - "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" - } - ], - "reverseName": "Material Universe smart link", - "name": "Process Universe smart link", - "guid": "4a029e9b-0535-49c3-ba90-bbd2f7991e8b" + "type": "numeric", + "unit": null + } + }, + "Example 7": { + "summary": "Change interpolation and scale type", + "description": "This example demonstrates how to update the interpolation type and scale type of the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database. The parameter must be a numeric parameter.", + "value": { + "type": "numeric", + "interpolationType": "cubicSpline", + "scaleType": "logarithmic" } } } } } - }, + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParameter" + }, + "example": { + "type": "numeric", + "isRestricted": false, + "unit": { + "symbol": "% strain", + "guid": "0000019b-0013-4fff-8fff-0000ffff0000" + }, + "values": [ + { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + }, + { + "type": "numeric", + "value": 1.0, + "guid": "00000005-000b-4fff-8fff-0005ffff0000" + } + ], + "interpolationType": "linear", + "scaleType": "linear", + "helpPath": "/help/Strain.html", + "defaultParameterValueGuid": "00000005-000b-4fff-8fff-0005ffff0000", + "displayNames": { + "en": "Strain", + "fr": "Souche" + }, + "name": "Strain", + "guid": "00000005-000a-4fff-8fff-0000ffff0000" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or parameter not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Parameters" + ], + "summary": "Delete a parameter.", + "operationId": "DeleteParameter", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], "responses": { - "201": { - "description": "Created", + "400": { + "description": "Bad request. Parameter in use.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "$ref": "#/components/schemas/GsaParameterDeletionException" }, - "examples": { - "Example 4": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } - }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 5": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "6e4644bf-be93-42d6-ad33-399ae8074529", - "tableGuid": "3afcf330-1e33-4a8e-a347-6b418ee7d147" - } - }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "163f6b09-cfcf-49c7-b825-50e6ff9d2144" - } - }, - "Example 6": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ + "example": { + "message": "Cannot delete parameter 'Strain' (GUID = '00000005-000a-4fff-8fff-0000ffff0000').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more attributes.", + "reason": "usage", + "referencedByType": "attribute", + "referencedBy": [ { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + "type": "floatFunctional", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + "name": "Tensile strength with temperature", + "guid": "00000002-0001-4fff-8fff-dd92ffff0000" } - }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + ] } - } + ] } } } }, - "400": { - "description": "Bad request", + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or parameter not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}:usages": { + "get": { + "tags": [ + "Schema - Parameters" + ], + "summary": "Get attributes which currently use the given parameter.", + "operationId": "GetObjectsUsingParameter", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parameter-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupCreationException" - }, - "examples": { - "Example 1": { - "summary": "Static record link group with duplicate name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a static link group with name 'Design Data', but there is already a static record link group with that name.", - "value": { - "message": "Cannot create record link group 'Design Data'.", - "code": "recordLinkGroupCreation", - "name": "Design Data", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "RecordLinkGroup with name 'Design Data' already exists in this Table.", - "name": "Design Data", - "parentEntityType": "table", - "reason": "nameAlreadyExists", - "entityType": "recordLinkGroup" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Smart record link group with multiple errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to create a smart link group with name 'Process', but: the name is the same as the reverse name, one of the specified linking attributes could not be found, and one of the specified linking attributes is duplicated.", - "value": { - "message": "Cannot create record link group 'Process'.", - "code": "recordLinkGroupCreation", - "name": "Process", - "errors": [ - { - "message": "Record link group name and reverse name cannot be the same.", - "reason": "nameSameAsReverseName" - }, - { - "message": "The attributes used as linking attribute pairs for a smart link group are not valid.", - "errors": [ - { - "message": "Could not find attribute with GUID 'be60d6f7-3724-4e00-83b6-cb2c6bbe34a4' in table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000' in database 'MI_TRAINING'.", - "databaseKey": "MI_TRAINING", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "be60d6f7-3724-4e00-83b6-cb2c6bbe34a4", - "reason": "noSuchAttribute" - }, - { - "message": "Smart record link group source and target attributes cannot contain duplicates. Attribute with GUID '0000000b-0001-4fff-8fff-dd92ffff0000' has already been specified in table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'. ", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", - "attributeGuid": "0000000b-0001-4fff-8fff-dd92ffff0000", - "reason": "attributeAlreadySpecified" - } - ], - "reason": "smartAttributes" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateStaticRecordLinkGroup: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } + "$ref": "#/components/schemas/GsaSlimObjects" } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or table not found" + "description": "Database or parameter not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}/{record-link-group-type}": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values/{parameter-value-guid}": { "get": { "tags": [ - "Schema - Record Link Groups" + "Schema - Parameters" ], - "summary": "Get individual record link group", - "operationId": "GetRecordLinkGroup", + "summary": "Get a parameter value with a specified guid for a given database for a given parameter.", + "operationId": "GetParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "parameter-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-link-group-guid", + "name": "parameter-value-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParameterValue" + }, + "example": { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + } + } + } }, + "404": { + "description": "Database, parameter or parameter value not found" + } + } + }, + "patch": { + "tags": [ + "Schema - Parameters" + ], + "summary": "Update a parameter value.", + "operationId": "UpdateParameterValue", + "parameters": [ { - "name": "record-link-group-type", + "name": "database-key", "in": "path", - "description": "The record link group type as entered.", "required": true, "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], "type": "string" } }, { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "name": "parameter-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "parameter-value-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "8a56ed5f-bb42-43c4-a797-40a6f0f4d7ca" + } }, - "examples": { - "Example 1": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } - }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 2": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "9caebfca-9a45-4c87-81d8-d7e75c2f4b0a", - "tableGuid": "69fd0634-1e10-42ea-b28d-19e81969fb78" - } - }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "59007a62-0b09-4831-ada1-22d22fed42e9" - } - }, - "Example 3": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - } - }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" - } + "Example 2": { + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "cef7cee9-e63d-44a9-a7c3-6220f763afa6" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "value": { + "type": "numeric", + "guid": "0b5544c4-3b3c-44df-ae4c-5300e3e5718d" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "8a56ed5f-bb42-43c4-a797-40a6f0f4d7ca" + } + }, + "Example 2": { + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "cef7cee9-e63d-44a9-a7c3-6220f763afa6" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "value": { + "type": "numeric", + "guid": "0b5544c4-3b3c-44df-ae4c-5300e3e5718d" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "8a56ed5f-bb42-43c4-a797-40a6f0f4d7ca" + } + }, + "Example 2": { + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "cef7cee9-e63d-44a9-a7c3-6220f763afa6" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "value": { + "type": "numeric", + "guid": "0b5544c4-3b3c-44df-ae4c-5300e3e5718d" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Update numeric parameter value", + "description": "This example demonstrates how to update all properties of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Strain 0.1 (Updated)", + "guid": "8a56ed5f-bb42-43c4-a797-40a6f0f4d7ca" + } + }, + "Example 2": { + "summary": "Update discrete parameter value", + "description": "This example demonstrates how to update all properties of the 'Mean' discrete parameter value (guid = 21a27377-12eb-413c-bac4-d4ffceda39d1) from the 'Basis' numeric parameter (guid = 7a6ccb7b-8a47-4cab-8203-c741d476560f) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Mean (Updated)", + "guid": "cef7cee9-e63d-44a9-a7c3-6220f763afa6" + } + }, + "Example 3": { + "summary": "Change guid of numeric", + "description": "This example demonstrates how to update guid of the 'Strain 0.1' numeric parameter value (guid = 173284fb-e557-406f-a7eb-f4e75f1d48a9) from the 'Strain' numeric parameter (guid = 00000005-000a-4fff-8fff-0000ffff0000) from the MI_Training database using a PATCH request.", + "value": { + "type": "numeric", + "guid": "0b5544c4-3b3c-44df-ae4c-5300e3e5718d" } } } } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParameterValue" + }, + "example": { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + } + } + } + }, + "400": { + "description": "Bad request. Parameter in use." + }, + "403": { + "description": "Forbidden." }, "404": { - "description": "Database, table or record link group not found" + "description": "Database, parameter or parameter value not found" } } }, "delete": { "tags": [ - "Schema - Record Link Groups" + "Schema - Parameters" ], - "summary": "Delete a record link group.", - "operationId": "DeleteRecordLinkGroup", + "summary": "Delete a parameter value.", + "operationId": "DeleteParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "parameter-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, { - "name": "record-link-group-guid", + "name": "parameter-value-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "record-link-group-type", - "in": "path", - "description": "The record link group type as entered.", - "required": true, - "schema": { - "enum": [ - "static", - "smart", - "crossDatabase" - ], - "type": "string" - } } ], "responses": { + "400": { + "description": "Bad request. Parameter in use.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParameterValueDeletionException" + }, + "example": { + "message": "Cannot delete parameter value 'Mean' (GUID = '21a27377-12eb-413c-bac4-d4ffceda39d1').", + "code": 400, + "errors": [ + { + "message": "It is being used in one or more parameters as a default value.", + "reason": "usage", + "referencedByType": "defaultParameterValue", + "referencedBy": [ + { + "name": "Basis", + "guid": "7a6ccb7b-8a47-4cab-8203-c741d476560f" + } + ] + } + ] + } + } + } + }, "200": { "description": "Ok" }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, table or record link group not found" + "description": "Database, parameter or parameter value not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}": { - "patch": { + "/v1alpha/databases/{database-key}/parameters/{parameter-guid}/parameter-values": { + "post": { "tags": [ - "Schema - Record Link Groups" + "Schema - Parameters" ], - "summary": "Update record link group.", - "operationId": "UpdateRecordLinkGroup", + "summary": "Create a new parameter value.", + "operationId": "CreateParameterValue", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "parameter-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateParameterValue" + }, + "examples": { + "Example 1": { + "summary": "Numeric parameter value", + "description": "This example demonstrates how to create a new numeric parameter value for the 'Temperature' numeric parameter (guid = 00000001-000a-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "value": 10.0, + "type": "numeric", + "name": "Cold" + } + }, + "Example 2": { + "summary": "Discrete parameter value", + "description": "This example demonstrates how to create a new discrete parameter value for the 'Chemical Environment' discrete parameter (guid = b7cee874-160f-439a-a784-b887c516b2d5) from the MI_Training database.", + "value": { + "type": "discrete", + "name": "Heavy water" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaParameterValue" + }, + "example": { + "type": "numeric", + "value": 0.1, + "guid": "173284fb-e557-406f-a7eb-f4e75f1d48a9" + } + } + } }, - { - "name": "record-link-group-guid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" + "400": { + "description": "Bad request. Parameter in use." + }, + "403": { + "description": "Forbidden." + }, + "404": { + "description": "Database or parameter not found" + } + } + } + }, + "/v1alpha/profiles": { + "get": { + "tags": [ + "Schema - Profiles" + ], + "summary": "Get AllProfilesInfo", + "operationId": "GetProfiles", + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAllProfilesInfo" + }, + "example": { + "profiles": [ + { + "key": "MI_Training", + "isImplicit": true, + "name": "MI Training" + }, + { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + }, + { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Composites" + }, + { + "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Additive Manufacturing" + } + ], + "defaultProfile": { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + } + } + } } + }, + "403": { + "description": "Forbidden" } + } + }, + "patch": { + "tags": [ + "Schema - Profiles" ], + "summary": "Update AllProfilesInfo", + "operationId": "UpdateAllProfilesInfo", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "type": "static", - "guid": "2c7d06c9-dd47-4735-81ca-1480121d63c2" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "defaultProfile": null } }, "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c8e30951-388a-41e1-81c5-3fb8a20aa3c2" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] } }, "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "27b9a329-c605-4bd9-9bbb-9ce99f70a11d" - } - }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "profiles": [ { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" }, { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" } ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "68a45d54-ad08-4135-b8ce-3945e6adb8ca" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "type": "static", - "guid": "2c7d06c9-dd47-4735-81ca-1480121d63c2" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "defaultProfile": null } }, "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c8e30951-388a-41e1-81c5-3fb8a20aa3c2" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] } }, "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "27b9a329-c605-4bd9-9bbb-9ce99f70a11d" - } - }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "profiles": [ { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" }, { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" } ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "68a45d54-ad08-4135-b8ce-3945e6adb8ca" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "type": "static", - "guid": "2c7d06c9-dd47-4735-81ca-1480121d63c2" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "defaultProfile": null } }, "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c8e30951-388a-41e1-81c5-3fb8a20aa3c2" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] } }, "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "27b9a329-c605-4bd9-9bbb-9ce99f70a11d" - } - }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "profiles": [ { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" }, { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" } ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "68a45d54-ad08-4135-b8ce-3945e6adb8ca" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" + "$ref": "#/components/schemas/GsaUpdateAllProfilesInfo" }, "examples": { "Example 1": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update default profile", + "description": "This example demonstrates how to update default profile. Default Profile might be set to one of the profiles visible to user or to null.", "value": { - "type": "static", - "guid": "2c7d06c9-dd47-4735-81ca-1480121d63c2" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } }, "Example 2": { - "summary": "Update name and reverse name", - "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Remove default profile", + "description": "This example demonstrates how to remove default profile by setting it to null", "value": { - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)" + "defaultProfile": null } }, "Example 3": { - "summary": "Update everything for static record link group", - "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", + "summary": "Update profiles order", + "description": "This example demonstrates how to reorder profiles. Profiles will be reordered in the order provided. Their values can not be changed. Full list of explicit profiles must be provided.", "value": { - "includeIndirectLinks": true, - "type": "static", - "reverseName": "Fatigue Statistical Data (updated)", - "name": "Fatigue Test Data (updated)", - "guid": "c8e30951-388a-41e1-81c5-3fb8a20aa3c2" + "profiles": [ + { + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" + }, + { + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" + } + ] } }, "Example 4": { - "summary": "Update everything for cross database record link group", - "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", - "value": { - "includeIndirectLinks": true, - "type": "crossDatabase", - "reverseName": "Link To MI Training - Material Universe (Updated)", - "name": "Link From MI Training - Material Universe (Updated)", - "guid": "27b9a329-c605-4bd9-9bbb-9ce99f70a11d" - } - }, - "Example 5": { - "summary": "Update everything for smart record link group", - "description": "This example demonstrates how to update all properties of 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "summary": "Everything for AllProfilesInfo", + "description": "This example shows all properties that can be updated for AllProfilesInfo.", "value": { - "forbidOrphans": true, - "referentialIntegrityModel": "oneToOne", - "attributePairs": [ + "profiles": [ { - "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658" }, { - "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", - "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f" + }, + { + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a" } ], - "type": "smart", - "reverseName": "Further panel information (Updated)", - "name": "Tensile test data (Updated)", - "guid": "68a45d54-ad08-4135-b8ce-3945e6adb8ca" + "defaultProfile": { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a" + } } } } @@ -66994,358 +44832,199 @@ }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "$ref": "#/components/schemas/GsaAllProfilesInfo" }, - "examples": { - "Example 10": { - "summary": "Static record link group", - "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", - "value": { - "type": "static", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" - } - }, - "identity": 125, - "reverseName": "Fatigue Statistical Data", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Fatigue Test Data", - "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" - } - }, - "Example 11": { - "summary": "Cross database record link group", - "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", - "value": { - "type": "crossDatabase", - "includeIndirectLinks": false, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "linkTarget": { - "databaseGuid": "bdf62879-2bd9-406d-a36f-0ff91d20ea7a", - "tableGuid": "892b9514-e83a-430a-911c-7053ce9c59eb" - } - }, - "identity": 1, - "reverseName": "MI Training - MaterialUniverse", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Different database - different table", - "guid": "2a85d1c6-c863-4b1b-8a5f-a310e4ef6f57" - } - }, - "Example 12": { - "summary": "Smart record link group", - "description": "This example demonstrates the returned value from getting a 'Tensile test data' smart record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", - "value": { - "type": "smart", - "forbidOrphans": false, - "referentialIntegrityModel": "oneToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Panel Number", - "displayNames": {}, - "attributeType": "shortText", - "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" - } - } - ], - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" - } - }, - "identity": 8, - "reverseName": "Further panel information", - "reverseDisplayNames": {}, - "displayNames": {}, - "name": "Tensile test data", - "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + "example": { + "profiles": [ + { + "key": "MI_Training", + "isImplicit": true, + "name": "MI Training" + }, + { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" + }, + { + "key": "MITrainingComposites-90cb537b-82e9-4e8b-8193-208f581f7e0a", + "guid": "90cb537b-82e9-4e8b-8193-208f581f7e0a", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Composites" + }, + { + "key": "MITrainingAdditiveManufacturing-31ae18d9-eaf7-43ab-9b88-716c34e61658", + "guid": "31ae18d9-eaf7-43ab-9b88-716c34e61658", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Additive Manufacturing" } + ], + "defaultProfile": { + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRecordLinkGroupUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Static record link group with duplicate name", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update 'Fatigue Test Data' static link group to have name 'Design Data', but there is already a static record link group with that name.", - "value": { - "message": "Cannot update record link group with GUID '485da78d-d094-4edb-a5a9-077fe1bc02f2'.", - "code": "recordLinkGroupUpdate", - "recordLinkGroupGuid": "485da78d-d094-4edb-a5a9-077fe1bc02f2", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "RecordLinkGroup with name 'Design Data' already exists in this Table.", - "name": "Design Data", - "parentEntityType": "table", - "reason": "nameAlreadyExists", - "entityType": "recordLinkGroup" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 2": { - "summary": "Smart record link group with multiple errors", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update 'Tensile Test Data' smart link group, but: the name is the same as the reverse name, one of the specified linking attributes could not be found, and one of the specified linking attributes is duplicated.", - "value": { - "message": "Cannot update record link group with GUID '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f'.", - "code": "recordLinkGroupUpdate", - "recordLinkGroupGuid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f", - "errors": [ - { - "message": "Record link group name and reverse name cannot be the same.", - "reason": "nameSameAsReverseName" - }, - { - "message": "The attributes used as linking attribute pairs for a smart link group are not valid.", - "errors": [ - { - "message": "Could not find attribute with GUID '0b08c7ed-2255-4ba7-8de3-14182149e2cb' in table with GUID '7db2ff8e-54ed-45d6-b522-e03c8be405b3' in database 'MI_TRAINING'.", - "databaseKey": "MI_TRAINING", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3", - "attributeGuid": "0b08c7ed-2255-4ba7-8de3-14182149e2cb", - "reason": "noSuchAttribute" - }, - { - "message": "Smart record link group source and target attributes cannot contain duplicates. Attribute with GUID '6e50a7a8-a759-44c9-b151-215a07949c1f' has already been specified in table with GUID '7db2ff8e-54ed-45d6-b522-e03c8be405b3'. ", - "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3", - "attributeGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", - "reason": "attributeAlreadySpecified" - } - ], - "reason": "smartAttributes" - } - ] - } - }, - "Example 3": { - "summary": "Invalid JSON", - "description": "The property 'name' cannot be set to null.", - "value": { - "message": "UpdateStaticRecordLinkGroup: Required property 'name' expects a non-null value", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database, table or record link group not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/replacement-strings": { - "get": { - "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Get all replacement strings", - "operationId": "GetReplacementStrings", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement strings will be searched for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReplacementStringsInfo" - }, - "example": { - "replacementStrings": [ - { - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" - } - ] - } - } - } - }, - "404": { - "description": "Database not found" + "description": "Profile not found" } } }, "post": { "tags": [ - "Schema - Replacement Strings" - ], - "summary": "Create a new replacement string.", - "operationId": "CreateReplacementString", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be created", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } + "Schema - Profiles" ], + "summary": "Create a new profile", + "operationId": "CreateProfile", "requestBody": { - "description": "Replacement string to add to database", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" + "$ref": "#/components/schemas/GsaCreateProfile" }, "examples": { "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" + "name": "MI:Training Processes" } }, "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "58fffc6e-5c86-4715-855d-c6b549cf1285" + "name": "MI:Training Processes", + "guid": "c3b3688d-04a5-49a9-8e9b-78caf749f790" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "46703a12-6919-446f-a8a8-5ffd220ddda3" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" + "$ref": "#/components/schemas/GsaCreateProfile" }, "examples": { "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" + "name": "MI:Training Processes" } }, "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "58fffc6e-5c86-4715-855d-c6b549cf1285" + "name": "MI:Training Processes", + "guid": "c3b3688d-04a5-49a9-8e9b-78caf749f790" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "46703a12-6919-446f-a8a8-5ffd220ddda3" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" + "$ref": "#/components/schemas/GsaCreateProfile" }, "examples": { "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" + "name": "MI:Training Processes" } }, "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "58fffc6e-5c86-4715-855d-c6b549cf1285" + "name": "MI:Training Processes", + "guid": "c3b3688d-04a5-49a9-8e9b-78caf749f790" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "46703a12-6919-446f-a8a8-5ffd220ddda3" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateReplacementString" + "$ref": "#/components/schemas/GsaCreateProfile" }, "examples": { "Example 1": { - "summary": "Replacement string", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "summary": "Profile", + "description": "This example demonstrates how to create a new profile", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website" + "name": "MI:Training Processes" } }, "Example 2": { - "summary": "Replacement string with specified guid", - "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "summary": "Profile with specified guid", + "description": "This example demonstrates how to create a new profile with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", "value": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "58fffc6e-5c86-4715-855d-c6b549cf1285" + "name": "MI:Training Processes", + "guid": "c3b3688d-04a5-49a9-8e9b-78caf749f790" + } + }, + "Example 3": { + "summary": "Full profile", + "description": "This example demonstrates how to create a new profile with all of its fields filled out.", + "value": { + "description": "#markdown\r\nFor process-oriented users.", + "homepageUrl": "TrainingProfiles/TrainingProcesses", + "groupName": "MI:Training Profiles", + "name": "MI:Training Processes", + "guid": "46703a12-6919-446f-a8a8-5ffd220ddda3" } } } @@ -67358,12 +45037,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacementString" + "$ref": "#/components/schemas/GsaProfile" }, "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } @@ -67373,36 +45072,21 @@ }, "403": { "description": "Forbidden" - }, - "404": { - "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/replacement-strings/{replacement-string-guid}": { + "/v1alpha/profiles/{profile-guid}": { "get": { "tags": [ - "Schema - Replacement Strings" + "Schema - Profiles" ], - "summary": "Get individual replacement string", - "operationId": "GetReplacementString", + "summary": "Get individual profile", + "operationId": "GetProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be searched for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", + "name": "profile-guid", "in": "path", - "description": "Guid of requested replacement string", "required": true, "schema": { "type": "string", @@ -67416,43 +45100,54 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacementString" + "$ref": "#/components/schemas/GsaProfile" }, "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database or replacement string not found" + "description": "Profile not found" } } }, "patch": { "tags": [ - "Schema - Replacement Strings" + "Schema - Profiles" ], - "summary": "Update a replacement string.", - "operationId": "UpdateReplacementString", + "summary": "Update a profile", + "operationId": "UpdateProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", + "name": "profile-guid", "in": "path", - "description": "Guid of replacement string to update", "required": true, "schema": { "type": "string", @@ -67461,124 +45156,147 @@ } ], "requestBody": { - "description": "Replacement string data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "28c5c3b6-f15e-476c-8968-daad87599396" + "guid": "8ed00dc6-d06d-4001-9abf-62d6c70d6fae" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "New name for replacement string" + "name": "MI:Training Metals (Updated)" } }, "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", "value": { - "value": "New value for replacement string" + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "355f7acf-9b1f-4edd-acc4-401072a90ffb", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "28c5c3b6-f15e-476c-8968-daad87599396" + "guid": "8ed00dc6-d06d-4001-9abf-62d6c70d6fae" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "New name for replacement string" + "name": "MI:Training Metals (Updated)" } }, "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", "value": { - "value": "New value for replacement string" + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "355f7acf-9b1f-4edd-acc4-401072a90ffb", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "28c5c3b6-f15e-476c-8968-daad87599396" + "guid": "8ed00dc6-d06d-4001-9abf-62d6c70d6fae" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "New name for replacement string" + "name": "MI:Training Metals (Updated)" } }, "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", "value": { - "value": "New value for replacement string" + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "355f7acf-9b1f-4edd-acc4-401072a90ffb", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateReplacementString" + "$ref": "#/components/schemas/GsaUpdateProfile" }, "examples": { "Example 1": { - "summary": "Everything for a replacement string", - "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "value": "New value for replacement string", - "name": "New name for replacement string", - "guid": "28c5c3b6-f15e-476c-8968-daad87599396" + "guid": "8ed00dc6-d06d-4001-9abf-62d6c70d6fae" } }, "Example 2": { - "summary": "Update name", - "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Update a name", + "description": "This example demonstrates how to update the 'Name' property of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", "value": { - "name": "New name for replacement string" + "name": "MI:Training Metals (Updated)" } }, "Example 3": { - "summary": "Update value", - "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", + "summary": "Everything for a profile", + "description": "This example demonstrates how to update all properties of the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f). Profile tables will be reordered in the order provided. Their values can not be changed. Full list of profiles profileTables must be provided.", "value": { - "value": "New value for replacement string" + "description": "#markdown\r\nFor metals-oriented users. (Updated)", + "homepageUrl": "TrainingProfiles/TrainingMetalsUpdated", + "profileTableGuids": [ + "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e" + ], + "guid": "355f7acf-9b1f-4edd-acc4-401072a90ffb", + "groupName": "MI:Training Profiles (Updated)", + "name": "MI:Training Metals" } } } @@ -67591,12 +45309,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaReplacementString" + "$ref": "#/components/schemas/GsaProfile" }, "example": { - "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", - "name": "Links to GRANTA MI support on the ANSYS Granta website", - "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" + "description": "#markdown\r\nFor metals-oriented users.", + "homepageUrl": "TrainingProfiles/MITrainingMetals", + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ], + "key": "MITrainingMetals-f76e3ce8-608a-42da-8d99-f0009dac966f", + "guid": "f76e3ce8-608a-42da-8d99-f0009dac966f", + "groupName": "MI:Training Profiles", + "isImplicit": false, + "name": "MI:Training Metals" } } } @@ -67608,32 +45346,20 @@ "description": "Forbidden" }, "404": { - "description": "Database or replacement string not found" + "description": "Profile not found" } } }, "delete": { "tags": [ - "Schema - Replacement Strings" + "Schema - Profiles" ], - "summary": "Delete a replacement string", - "operationId": "DeleteReplacementString", + "summary": "Delete a profile", + "operationId": "DeleteProfile", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "Database in which replacement string will be search for", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "replacement-string-guid", + "name": "profile-guid", "in": "path", - "description": "Guid of replacement string to delete", "required": true, "schema": { "type": "string", @@ -67645,127 +45371,34 @@ "200": { "description": "Ok" }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "Database or replacement string not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/search-masks": { - "get": { - "tags": [ - "Schema - Search Masks" - ], - "summary": "Get all search masks.", - "operationId": "GetSearchMasks", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } + "400": { + "description": "Bad request. Profile is set as default." }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchMaskInfo" - } - } - } + "403": { + "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Profile not found" } } } }, - "/v1alpha/databases/{database-key}/search-masks/{search-mask-guid}": { + "/v1alpha/profiles/{profile-guid}/profile-tables": { "get": { "tags": [ - "Schema - Search Masks" + "Schema - ProfileTables" ], - "summary": "Get a specific search mask by GUID.", - "operationId": "GetSearchMask", + "summary": "Get all profile tables of given profile", + "operationId": "GetProfileTables", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "search-mask-guid", + "name": "profile-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { @@ -67774,230 +45407,216 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchMask" + "$ref": "#/components/schemas/GsaProfileTablesInfo" + }, + "example": { + "profileTables": [ + { + "guid": "a7cb2018-8410-42fd-ac6a-8bc1b441ba6e", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "MaterialUniverse" + }, + { + "guid": "81bb4607-e2a3-4c78-81fc-a18a09979c72", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "ProcessUniverse" + } + ] } } } }, - "404": { - "description": "Database or search mask not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates": { - "get": { - "tags": [ - "Schema - Search Templates" - ], - "summary": "Get all search templates for a table.", - "operationId": "GetSearchTemplates", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchTemplateInfo" - } - } - } + "403": { + "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Profile not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/search-templates/{search-template-guid}": { - "get": { + }, + "post": { "tags": [ - "Schema - Search Templates" + "Schema - ProfileTables" ], - "summary": "Get a specific search template by GUID.", - "operationId": "GetSearchTemplate", + "summary": "Create a new profile table", + "operationId": "CreateProfileTable", "parameters": [ { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "search-template-guid", + "name": "profile-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaSearchTemplate" - } - } - } - }, - "404": { - "description": "Database, table, or search template not found" - } - } - } - }, - "/v1alpha/securityGroups/defaultFallback": { - "get": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Returns the default fallback (global) security groups.", - "operationId": "GetDefaultFallbackSecurityGroups", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDefaultFallbackSecurityGroups" - } - } - } - }, - "403": { - "description": "Forbidden if the user is not a system administrator." } - } - }, - "patch": { - "tags": [ - "Schema - Security Groups" ], - "summary": "Updates the default fallback (global) security groups.", - "operationId": "UpdateDefaultFallbackSecurityGroups", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" + "$ref": "#/components/schemas/GsaCreateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + } + }, + "Example 2": { + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "117acf88-9e91-4750-afe2-2eff14770ec3" + } + }, + "Example 3": { + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "62df94e5-3eb4-4565-8af4-a5ef866f3a27" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" + "$ref": "#/components/schemas/GsaCreateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + } + }, + "Example 2": { + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "117acf88-9e91-4750-afe2-2eff14770ec3" + } + }, + "Example 3": { + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "62df94e5-3eb4-4565-8af4-a5ef866f3a27" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" + "$ref": "#/components/schemas/GsaCreateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + } + }, + "Example 2": { + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "117acf88-9e91-4750-afe2-2eff14770ec3" + } + }, + "Example 3": { + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "62df94e5-3eb4-4565-8af4-a5ef866f3a27" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDefaultFallbackSecurityGroups" + "$ref": "#/components/schemas/GsaCreateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f)", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e" + } + }, + "Example 2": { + "summary": "Profile Table with specified guid", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "guid": "117acf88-9e91-4750-afe2-2eff14770ec3" + } + }, + "Example 3": { + "summary": "Full Profile Table", + "description": "This example demonstrates how to create a new profile table for the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f) with all of its fields filled out.", + "value": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "tableGuid": "bc666ac6-8ac6-482b-9a16-502e6ab3730e", + "subsetGuid": "c2a6b6d0-540c-4927-b861-840644fc3968", + "layoutGuid": "f8379ae4-a8a8-4329-b9b5-cd0b2d285fd0", + "guid": "62df94e5-3eb4-4565-8af4-a5ef866f3a27" + } + } } } } }, "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDefaultFallbackSecurityGroups" + "$ref": "#/components/schemas/GsaProfileTable" + }, + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } @@ -68006,120 +45625,94 @@ "description": "Bad request" }, "403": { - "description": "Forbidden if the user is not a system administrator." + "description": "Forbidden" + }, + "404": { + "description": "Profile not found" } } } }, - "/v1alpha/securityGroups/databases": { + "/v1alpha/profiles/{profile-guid}/profile-tables/{profile-table-guid}": { "get": { "tags": [ - "Schema - Security Groups" + "Schema - ProfileTables" ], - "summary": "Returns the prevailing security groups defined for each database.", - "operationId": "GetDatabaseSecurityGroups", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroupsInfo" - } - } + "summary": "Get individual profile table", + "operationId": "GetProfileTable", + "parameters": [ + { + "name": "profile-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" } }, - "403": { - "description": "Forbidden if the user is not a system administrator." - } - } - } - }, - "/v1alpha/securityGroups/databases/{databaseKey}": { - "post": { - "tags": [ - "Schema - Security Groups" - ], - "summary": "Adds security groups for a specific database.", - "operationId": "AddDatabaseSecurityGroups", - "parameters": [ { - "name": "databaseKey", + "name": "profile-table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaAddDatabaseSecurityGroups" - } - } - } - }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaProfileTable" + }, + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } }, - "201": { - "description": "Created" - }, - "400": { - "description": "Bad request" - }, "403": { - "description": "Forbidden if the user is not a system administrator." + "description": "Forbidden" }, - "409": { - "description": "Conflict" + "404": { + "description": "Profile or profile table not found" } } }, "patch": { "tags": [ - "Schema - Security Groups" + "Schema - ProfileTables" ], - "summary": "Updates the security groups for a specific database.", - "operationId": "UpdateDatabaseSecurityGroups", + "summary": "Update a profile table", + "operationId": "UpdateProfileTable", "parameters": [ { - "name": "databaseKey", + "name": "profile-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "profile-table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -68127,33 +45720,148 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaUpdateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "0b084e35-07e7-42ce-b7fc-466c218abd83" + } + }, + "Example 2": { + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "87319afa-2878-4779-9345-6657e1ea3181" + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaUpdateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "0b084e35-07e7-42ce-b7fc-466c218abd83" + } + }, + "Example 2": { + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "87319afa-2878-4779-9345-6657e1ea3181" + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaUpdateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "0b084e35-07e7-42ce-b7fc-466c218abd83" + } + }, + "Example 2": { + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "87319afa-2878-4779-9345-6657e1ea3181" + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaUpdateProfileTable" + }, + "examples": { + "Example 1": { + "summary": "Everything for a profile table", + "description": "This example shows how to update all properties of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "layoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "guid": "0b084e35-07e7-42ce-b7fc-466c218abd83" + } + }, + "Example 2": { + "summary": "Remove subset and layout", + "description": "This example shows how to remove the 'Subset' and 'Layout' properties from the 'Design Data' profile table (guid = 2aa49cb3-19a4-44e3-a389-278123c96631) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "subsetGuid": null, + "layoutGuid": null + } + }, + "Example 3": { + "summary": "Just guid", + "description": "This example shows how to update the 'Guid' property of the 'MaterialUniverse' profile table (guid = a7cb2018-8410-42fd-ac6a-8bc1b441ba6e) from the 'MI:Training Metals' profile (guid = f76e3ce8-608a-42da-8d99-f0009dac966f).", + "value": { + "guid": "87319afa-2878-4779-9345-6657e1ea3181" + } + } } } } }, "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" + "$ref": "#/components/schemas/GsaProfileTable" + }, + "example": { + "subsetGuid": "c43d5d46-1d6a-4fd3-8cc7-923e8592daec", + "subsetFallbackHint": "Metals", + "layoutGuid": "2826bb31-9fb5-4ca5-8db2-121ae944221d", + "layoutFallbackHint": "Metals", + "guid": "2aa49cb3-19a4-44e3-a389-278123c96631", + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseFallbackHint": "MI:Training", + "tableGuid": "0000b5e2-0011-4fff-8fff-0000ffff0000", + "tableFallbackHint": "Design Data" } } } @@ -68162,65 +45870,99 @@ "description": "Bad request" }, "403": { - "description": "Forbidden if the user is not a system administrator." + "description": "Forbidden" }, "404": { - "description": "Not found" + "description": "Profile or profile table not found" } } }, "delete": { "tags": [ - "Schema - Security Groups" + "Schema - ProfileTables" ], - "summary": "Deletes the security groups defined for a specific database.", - "operationId": "RemoveDatabaseSecurityGroups", + "summary": "Delete a profile table", + "operationId": "DeleteProfileTable", "parameters": [ { - "name": "databaseKey", + "name": "profile-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "profile-table-guid", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No content" + "description": "Ok" }, "403": { - "description": "Forbidden if the user is not a system administrator." + "description": "Forbidden" }, "404": { - "description": "Not found" + "description": "Profile or profile table not found" } } } }, - "/v1alpha/databases/{database-key}/standard-names": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups": { "get": { "tags": [ - "Schema - Standard Names" + "Schema - Record Link Groups" ], - "summary": "Gets all standard names for a given database.", - "operationId": "GetStandardNames", + "summary": "Get all record link groups pointing from this table.", + "operationId": "GetRecordLinkGroups", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -68230,32 +45972,75 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNamesInfo" + "$ref": "#/components/schemas/GsaRecordLinkGroupsInfo" + }, + "example": { + "recordLinkGroups": [ + { + "identity": 115, + "type": "static", + "reverseName": "Training Exercise", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "MaterialUniverse", + "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + }, + { + "identity": 3, + "type": "dynamic", + "reverseName": "Smart Link to Training Record", + "reverseDisplayNames": { + "en": "en-Smart Link to Training Record", + "fr": "fr-Smart Link to Training Record" + }, + "displayNames": { + "en": "en-Smart Link to MaterialUniverse", + "fr": "fr-Smart Link to MaterialUniverse" + }, + "name": "Smart Link to MaterialUniverse", + "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + }, + { + "identity": 1, + "type": "crossDatabase", + "reverseName": "Second Training Database And Table - MI Training Exercise for Import", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "MI Training Exercise for Import - Second Training Database And Table", + "guid": "ba70aa0a-9864-41ae-a3ea-9afb84dba3ca" + } + ] } } } }, "404": { - "description": "Database not found" + "description": "Database or table not found" } } }, "post": { "tags": [ - "Schema - Standard Names" + "Schema - Record Link Groups" ], - "summary": "Create a new standard name", - "operationId": "CreateStandardName", + "summary": "Create a new record link group.", + "operationId": "CreateRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -68263,324 +46048,444 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" } }, "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "fe14b1d9-6d58-430a-9e14-cb6025cfa972" } }, "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", "value": { - "mappedRecordLinkGroups": [ - { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - } - ], - "name": "Unification" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "31658164-1dc1-4f09-91ca-6229f9182b3b" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" } }, "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "3a42aab6-075d-467e-947b-0a837b37170d", + "tableGuid": "ec7fce3a-d90e-4059-9250-4736e9adbe8f" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "6c03068f-b0bb-4574-b042-d830c5a2201d" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "0d43de07-5e99-4232-a211-710c36367df6" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } ], - "name": "Unification" + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedAttributes": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } ], - "name": "Unification" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "5c7ce3c1-a004-4ba2-a292-cfe042b07803" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" } }, "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "fe14b1d9-6d58-430a-9e14-cb6025cfa972" + } + }, + "Example 3": { + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "31658164-1dc1-4f09-91ca-6229f9182b3b" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" } }, - "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "Example 4": { + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", "value": { - "mappedRecordLinkGroups": [ - { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - } - ], - "name": "Unification" + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "3a42aab6-075d-467e-947b-0a837b37170d", + "tableGuid": "ec7fce3a-d90e-4059-9250-4736e9adbe8f" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "6c03068f-b0bb-4574-b042-d830c5a2201d" } }, - "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "0d43de07-5e99-4232-a211-710c36367df6" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } ], - "name": "Unification" + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedAttributes": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } ], - "name": "Unification" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "5c7ce3c1-a004-4ba2-a292-cfe042b07803" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" } }, "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "fe14b1d9-6d58-430a-9e14-cb6025cfa972" } }, "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", "value": { - "mappedRecordLinkGroups": [ - { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - } - ], - "name": "Unification" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "31658164-1dc1-4f09-91ca-6229f9182b3b" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" } }, "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "3a42aab6-075d-467e-947b-0a837b37170d", + "tableGuid": "ec7fce3a-d90e-4059-9250-4736e9adbe8f" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "6c03068f-b0bb-4574-b042-d830c5a2201d" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "0d43de07-5e99-4232-a211-710c36367df6" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } ], - "name": "Unification" + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedAttributes": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } ], - "name": "Unification" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "5c7ce3c1-a004-4ba2-a292-cfe042b07803" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateStandardName" + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Standard name for attributes", - "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", + "summary": "Static record link group", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static self link reversed", + "name": "Material Universe static self link" } }, "Example 2": { - "summary": "Standard name for parameters", - "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", + "summary": "Static record link group with specified guid", + "description": "This example demonstrates how to create a new static record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - }, - { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" - } - ], - "name": "Unification" + "type": "static", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe static link", + "name": "Process Universe static link", + "guid": "fe14b1d9-6d58-430a-9e14-cb6025cfa972" } }, "Example 3": { - "summary": "Standard name for record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", + "summary": "Cross database record link group", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to a table in different databases. Since no database guid is specified this will link to all databases containing this table.", "value": { - "mappedRecordLinkGroups": [ - { - "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" - } - ], - "name": "Unification" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkTarget": { + "tableGuid": "31658164-1dc1-4f09-91ca-6229f9182b3b" + }, + "reverseName": "Cross database link to Material Universe", + "name": "Cross database link from Material Universe" } }, "Example 4": { - "summary": "Standard name for cross-database record link groups", - "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", + "summary": "Cross database record link group with specified guid and target database guid", + "description": "This example demonstrates how to create a new cross database record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated. This will link from 'MaterialUniverse' table to a table in different database. Since the database guid is specified it will link to all versions of that specific database.", "value": { - "mappedCrossDatabaseRecordLinkGroups": [ + "type": "crossDatabase", + "includeIndirectLinks": true, + "linkTarget": { + "databaseGuid": "3a42aab6-075d-467e-947b-0a837b37170d", + "tableGuid": "ec7fce3a-d90e-4059-9250-4736e9adbe8f" + }, + "reverseName": "Cross database link to MI Training - Material Universe", + "name": "Cross database link from MI Training - Material Universe", + "guid": "6c03068f-b0bb-4574-b042-d830c5a2201d" + } + }, + "Example 5": { + "summary": "Dynamic record link group", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000'). This will link from 'MaterialUniverse' table to itself. Created link will have 'One to One' referential integrity model and will allow orphans.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "0d43de07-5e99-4232-a211-710c36367df6" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "000002cf-0001-4fff-8fff-dd92ffff0000" } ], - "name": "Unification" + "linkTarget": { + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic self link reversed", + "name": "Material Universe dynamic self link" } }, - "Example 5": { - "summary": "Standard name for attributes and parameters", - "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "Example 6": { + "summary": "Dynamic record link group with all fields specified", + "description": "This example demonstrates how to create a new dynamic record link group for the MI_Training database in 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') with a specified guid, referential integrity model and forbid orphans flag. If the guid is not specified a random new Guid will be generated. If referential integrity model is not specified it defaults to 'One to One' model. If forbid orphans flag is not specified it defaults to allowing them. This link group will link from 'MaterialUniverse' table to 'ProcessUniverse' table", "value": { - "mappedAttributes": [ + "type": "dynamic", + "forbidOrphans": true, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + "attributeSourceGuid": "bd489a13-97ee-4933-a677-7a18513e0997", + "attributeTargetGuid": "00000079-0001-4fff-8fff-3248ffff0000" }, { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ], - "mappedParameters": [ - { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "0000007c-0001-4fff-8fff-dd92ffff0000", + "attributeTargetGuid": "000000cf-0001-4fff-8fff-3248ffff0000" } ], - "name": "Unification" + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "00003248-0011-4fff-8fff-0000ffff0000" + }, + "reverseName": "Material Universe dynamic link", + "name": "Process Universe dynamic link", + "guid": "5c7ce3c1-a004-4ba2-a292-cfe042b07803" } } } @@ -68593,151 +46498,399 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardName" + "$ref": "#/components/schemas/GsaRecordLinkGroup" + }, + "examples": { + "Example 4": { + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", + "value": { + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" + } + }, + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" + } + }, + "Example 5": { + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", + "value": { + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "linkTarget": { + "databaseGuid": "bf4ad09d-ac84-43e3-b7bf-720a9435985f", + "tableGuid": "f3e9e42e-a2a4-429d-91b7-06014109c4a9" + } + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "613c70dd-9c30-4166-8131-c3c9264593d9" + } + }, + "Example 6": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ + { + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + }, + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } + } + ], + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + } + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" + } + } } } } }, "400": { - "description": "Bad request", + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}/{record-link-group-type}": { + "get": { + "tags": [ + "Schema - Record Link Groups" + ], + "summary": "Get individual record link group", + "operationId": "GetRecordLinkGroup", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-link-group-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "record-link-group-type", + "in": "path", + "description": "The record link group type.", + "required": true, + "schema": { + "enum": [ + "static", + "dynamic", + "crossDatabase" + ], + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNameCreationException" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Standard name already exists", - "description": "A standard name with the same name already exists in the database.", + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", "value": { - "message": "Cannot create standard name 'Density'.", - "code": "standardNameCreation", - "errors": [ - { - "message": "A standard name with name 'Density' already exists", - "standardName": "Density", - "reason": "standardNameAlreadyExists" + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" } - ] + }, + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" } }, "Example 2": { - "summary": "Duplicate mapped attribute GUIDs", - "description": "The mapped attributes contain duplicate GUIDs.", + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", "value": { - "message": "Cannot create standard name 'NewStandardName'.", - "code": "standardNameCreation", - "errors": [ + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "linkTarget": { + "databaseGuid": "7b488a40-9a53-4499-b6fd-db5de1278b33", + "tableGuid": "5d7a2b37-c325-4a4d-9213-d231758518e8" + } + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "14ef3826-3f00-4933-9e72-ac5b93eb38cf" + } + }, + "Example 3": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", + "value": { + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "message": "Duplicated attribute GUIDs present", - "reason": "duplicateMappedAttributeGuids" + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + }, + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } } - ] - } - }, - "Example 3": { - "summary": "Unresolved attribute GUIDs", - "description": "One or more attribute GUIDs could not be resolved.", - "value": { - "message": "Cannot create standard name 'NewStandardName'.", - "code": "standardNameCreation", - "errors": [ - { - "message": "The following attribute GUIDs did not resolve: [8f22c6a2-266b-4b2f-b601-5924b400cc0f]", - "unresolvedGuids": [ - "8f22c6a2-266b-4b2f-b601-5924b400cc0f" - ], - "reason": "unresolvedAttributeGuids" + ], + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateStandardName: Required property 'name' not found in JSON", - "code": "jsonSerialization" + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } } } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database not found" + "description": "Database, table or record link group not found" } } - } - }, - "/v1alpha/databases/{database-key}/standard-names/{standard-name-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Standard Names" + "Schema - Record Link Groups" ], - "summary": "Gets a standard name for a given database and guid.", - "operationId": "GetStandardName", + "summary": "Delete a record link group.", + "operationId": "DeleteRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "standard-name-guid", + "name": "record-link-group-guid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } + }, + { + "name": "record-link-group-type", + "in": "path", + "description": "The record link group type.", + "required": true, + "schema": { + "enum": [ + "static", + "dynamic", + "crossDatabase" + ], + "type": "string" + } } ], "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardName" - } - } - } + "description": "Ok" + }, + "403": { + "description": "Forbidden" }, "404": { - "description": "Database or standard name not found" + "description": "Database, table or record link group not found" } } - }, + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/record-link-groups/{record-link-group-guid}": { "patch": { "tags": [ - "Schema - Standard Names" + "Schema - Record Link Groups" ], - "summary": "Edit a standard name", - "operationId": "UpdateStandardName", + "summary": "Update record link group.", + "operationId": "UpdateRecordLinkGroup", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "standard-name-guid", + "name": "table-guid", "in": "path", "required": true, "schema": { @@ -68746,12 +46899,12 @@ } }, { - "name": "forceNonCustom", - "in": "query", - "description": "Optionally force the update for non-custom standard names.", + "name": "record-link-group-guid", + "in": "path", + "required": true, "schema": { - "type": "boolean", - "default": false + "type": "string", + "format": "uuid" } } ], @@ -68759,200 +46912,272 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "name": "Density (Updated)" + "type": "static", + "guid": "eaab1456-bab3-48e8-9356-2f58f51b2518" } }, "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "guid": "d3543ca4-e0c6-4800-ada7-a0fac584fac2" + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" } }, "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "e9359b98-39c3-4565-a9e5-efacd6d7f8eb" } }, "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "mappedAttributes": [], - "mappedParameters": [ + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "f1c9e76c-3d5c-4586-a90d-d7063e00c61e" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" }, { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" } - ] + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "40e17695-1046-4a4b-bf66-a05838c47416" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "name": "Density (Updated)" + "type": "static", + "guid": "eaab1456-bab3-48e8-9356-2f58f51b2518" } }, "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "guid": "d3543ca4-e0c6-4800-ada7-a0fac584fac2" + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" } }, "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "e9359b98-39c3-4565-a9e5-efacd6d7f8eb" } }, "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "mappedAttributes": [], - "mappedParameters": [ + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "f1c9e76c-3d5c-4586-a90d-d7063e00c61e" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" }, { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" } - ] + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "40e17695-1046-4a4b-bf66-a05838c47416" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "name": "Density (Updated)" + "type": "static", + "guid": "eaab1456-bab3-48e8-9356-2f58f51b2518" } }, "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "guid": "d3543ca4-e0c6-4800-ada7-a0fac584fac2" + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" } }, "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "e9359b98-39c3-4565-a9e5-efacd6d7f8eb" } }, "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "mappedAttributes": [], - "mappedParameters": [ + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "f1c9e76c-3d5c-4586-a90d-d7063e00c61e" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" }, { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" } - ] + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "40e17695-1046-4a4b-bf66-a05838c47416" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateStandardName" + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, "examples": { "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "name": "Density (Updated)" + "type": "static", + "guid": "eaab1456-bab3-48e8-9356-2f58f51b2518" } }, "Example 2": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update name and reverse name", + "description": "This example demonstrates how to update the 'Name' and 'Reverse name' properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "guid": "d3543ca4-e0c6-4800-ada7-a0fac584fac2" + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)" } }, "Example 3": { - "summary": "Update mapped attributes", - "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for static record link group", + "description": "This example demonstrates how to update all properties of the 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from the 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from the MI_Training database.", "value": { - "mappedAttributes": [ - { - "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" - }, - { - "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" - } - ] + "includeIndirectLinks": true, + "type": "static", + "reverseName": "Fatigue Statistical Data (updated)", + "name": "Fatigue Test Data (updated)", + "guid": "e9359b98-39c3-4565-a9e5-efacd6d7f8eb" } }, "Example 4": { - "summary": "Replace mapped attributes with parameters", - "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "summary": "Update everything for cross database record link group", + "description": "This example demonstrates how to update all properties of cross database record link group from the 'MaterialUniverse' table (GUID = '0000dd92-0011-4fff-8fff-0000ffff0000') from the MI_Training database.", "value": { - "mappedAttributes": [], - "mappedParameters": [ + "includeIndirectLinks": true, + "type": "crossDatabase", + "reverseName": "Link To MI Training - Material Universe (Updated)", + "name": "Link From MI Training - Material Universe (Updated)", + "guid": "f1c9e76c-3d5c-4586-a90d-d7063e00c61e" + } + }, + "Example 5": { + "summary": "Update everything for dynamic record link group", + "description": "This example demonstrates how to update all properties of 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from the 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from the MI_Training database.", + "value": { + "forbidOrphans": true, + "referentialIntegrityModel": "oneToOne", + "attributePairs": [ { - "guid": "00000001-000a-4fff-8fff-0000ffff0000" + "attributeSourceGuid": "6e50a7a8-a759-44c9-b151-215a07949c1f", + "attributeTargetGuid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" }, { - "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + "attributeSourceGuid": "1228c02f-25e7-4748-bcfa-038c334c73e4", + "attributeTargetGuid": "61796104-14e0-4d59-bdba-22a9277f4775" } - ] + ], + "type": "dynamic", + "reverseName": "Further panel information (Updated)", + "name": "Tensile test data (Updated)", + "guid": "40e17695-1046-4a4b-bf66-a05838c47416" } } } @@ -68961,233 +47186,345 @@ }, "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaStandardName" - } - } - } - }, - "400": { - "description": "Bad request", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNameUpdateException" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, "examples": { - "Example 1": { - "summary": "Standard name already exists", - "description": "A standard name with the same name already exists in the database.", + "Example 7": { + "summary": "Static record link group", + "description": "This example demonstrates the returned value from getting a 'Fatigue Test Data' static record link group (GUID = '485da78d-d094-4edb-a5a9-077fe1bc02f2') from 'Fatigue Statistical Data' table (GUID = 'c9954321-b4d4-4443-949e-f9b161e2c8fb') from MI_Training database.", "value": { - "message": "Cannot update standard name 'Density'.", - "code": "standardNameUpdate", - "errors": [ - { - "message": "A standard name with name 'Density' already exists", - "standardName": "Density", - "reason": "standardNameAlreadyExists" + "type": "static", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "c9954321-b4d4-4443-949e-f9b161e2c8fb" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "73d8f19a-38df-4144-964d-cc1448d38ebb" } - ] + }, + "identity": 125, + "reverseName": "Fatigue Statistical Data", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Fatigue Test Data", + "guid": "485da78d-d094-4edb-a5a9-077fe1bc02f2" } }, - "Example 2": { - "summary": "Duplicate mapped attribute GUIDs", - "description": "The mapped attributes contain duplicate GUIDs.", + "Example 8": { + "summary": "Cross database record link group", + "description": "This example demonstrates the returned value from getting a cross database record link group from 'MaterialUniverse' table from MI_Training database.", "value": { - "message": "Cannot update standard name 'ExistingStandardName'.", - "code": "standardNameUpdate", - "errors": [ - { - "message": "Duplicated attribute GUIDs present", - "reason": "duplicateMappedAttributeGuids" + "type": "crossDatabase", + "includeIndirectLinks": false, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, + "linkTarget": { + "databaseGuid": "4e6e0967-d068-46eb-b8c6-848c236bad44", + "tableGuid": "667a148b-7730-4ed0-a23e-03237fa0f751" } - ] + }, + "identity": 1, + "reverseName": "MI Training - MaterialUniverse", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Different database - different table", + "guid": "46ac6968-d5fb-4958-b2d1-075eaec7bf11" } }, - "Example 3": { - "summary": "Unresolved attribute GUIDs", - "description": "One or more attribute GUIDs could not be resolved.", + "Example 9": { + "summary": "Dynamic record link group", + "description": "This example demonstrates the returned value from getting a 'Tensile test data' dynamic record link group (GUID = '5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f') from 'Composite Pedigree' table (GUID = '7db2ff8e-54ed-45d6-b522-e03c8be405b3') from MI_Training database.", "value": { - "message": "Cannot update standard name 'ExistingStandardName'.", - "code": "standardNameUpdate", - "errors": [ + "type": "dynamic", + "forbidOrphans": false, + "referentialIntegrityModel": "oneToMany", + "attributePairs": [ { - "message": "The following attribute GUIDs did not resolve: [f6a42fcc-a03c-40dd-b2ed-30b1d217df29]", - "unresolvedGuids": [ - "f6a42fcc-a03c-40dd-b2ed-30b1d217df29" - ], - "reason": "unresolvedAttributeGuids" + "attributeSource": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "6e50a7a8-a759-44c9-b151-215a07949c1f" + }, + "attributeTarget": { + "type": "shortText", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" + }, + "displayNames": {}, + "name": "Panel Number", + "guid": "ab0ddcf2-d73e-44b1-9e69-383a7374edf7" + } } - ] - } - }, - "Example 4": { - "summary": "Rename a 'non-custom' standard name", - "description": "The standard name to be renamed was a 'non-custom' standard name.", - "value": { - "message": "Cannot update standard name 'Young's Modulus'.", - "code": "standardNameUpdate", - "errors": [ - { - "message": "The standard name with name 'Young's Modulus' is non-custom. The names of non-custom standard names cannot be changed.", - "standardName": "Young's Modulus", - "reason": "nonCustomStandardNameCannotBeChanged" + ], + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "7db2ff8e-54ed-45d6-b522-e03c8be405b3" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0dd5348e-72f3-4bcb-bb38-621e5953a333" } - ] + }, + "identity": 8, + "reverseName": "Further panel information", + "reverseDisplayNames": {}, + "displayNames": {}, + "name": "Tensile test data", + "guid": "5b8fca7e-b8e7-4fc6-8e02-642b3fb3218f" } - }, - "Example 5": { - "summary": "Invalid JSON", - "description": "The JSON body could not be deserialized.", - "value": { - "message": "UpdateStandardName: Invalid JSON in request body", - "code": "jsonSerialization" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or record link group not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/replacement-strings": { + "get": { + "tags": [ + "Schema - Replacement Strings" + ], + "summary": "Get all replacement strings", + "operationId": "GetReplacementStrings", + "parameters": [ + { + "name": "database-key", + "in": "path", + "description": "Database in which replacement strings will be searched for", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaReplacementStringsInfo" + }, + "example": { + "replacementStrings": [ + { + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } - } + ] } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or standard name not found" + "description": "Database not found" } } }, - "delete": { + "post": { "tags": [ - "Schema - Standard Names" + "Schema - Replacement Strings" ], - "summary": "Delete a standard name.", - "operationId": "DeleteStandardName", + "summary": "Create a new replacement string.", + "operationId": "CreateReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "standard-name-guid", - "in": "path", + "description": "Database in which replacement string will be created", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "forceNonCustom", - "in": "query", - "description": "Optionally force the deletion for non-custom standard names.", - "schema": { - "type": "boolean", - "default": false + "type": "string" } } ], + "requestBody": { + "description": "Replacement string to add to database", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "e692c400-59de-428f-a94c-455b2a56013a" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "e692c400-59de-428f-a94c-455b2a56013a" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "e692c400-59de-428f-a94c-455b2a56013a" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateReplacementString" + }, + "examples": { + "Example 1": { + "summary": "Replacement string", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website" + } + }, + "Example 2": { + "summary": "Replacement string with specified guid", + "description": "This example demonstrates how to create a new replacement string for the MI_Training database with a specified guid. Normally, if the guid is not specified, a random new Guid will be generated.", + "value": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "e692c400-59de-428f-a94c-455b2a56013a" + } + } + } + } + } + }, "responses": { - "400": { - "description": "Bad request.", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaStandardNameDeletionException" + "$ref": "#/components/schemas/GsaReplacementString" }, - "examples": { - "Example 1": { - "summary": "Delete a 'non-custom' standard name", - "description": "The standard name to be deleted was a 'non-custom' standard name.", - "value": { - "message": "Cannot delete standard name 'Young's Modulus'.", - "code": "standardNameDeletion", - "errors": [ - { - "message": "The standard name with name 'Young's Modulus' is non-custom. Non-custom standard names cannot be deleted.", - "reason": "nonCustomStandardNameCannotBeDeleted" - } - ] - } - } + "example": { + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } } } }, - "200": { - "description": "Ok" + "400": { + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database or standard name not found." + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets": { + "/v1alpha/databases/{database-key}/replacement-strings/{replacement-string-guid}": { "get": { "tags": [ - "Schema - Subsets" + "Schema - Replacement Strings" ], - "summary": "Get all subsets for table", - "operationId": "GetSubsets", + "summary": "Get individual replacement string", + "operationId": "GetReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement string will be searched for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "replacement-string-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "Guid of requested replacement string", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } } ], "responses": { @@ -69196,194 +47533,167 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSubsetsInfo" + "$ref": "#/components/schemas/GsaReplacementString" }, "example": { - "subsets": [ - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": {}, - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": {}, - "name": "Polymers", - "guid": "00007645-0010-4fff-8fff-dd92ffff0000" - } - ] + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } } } }, "404": { - "description": "Database or table not found" + "description": "Database or replacement string not found" } } }, - "post": { + "patch": { "tags": [ - "Schema - Subsets" + "Schema - Replacement Strings" ], - "summary": "Create a new subset.", - "operationId": "CreateSubset", + "summary": "Update a replacement string.", + "operationId": "UpdateReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement string will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "replacement-string-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "Guid of replacement string to update", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } ], "requestBody": { + "description": "Replacement string data to be updated", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "9ea460a1-7062-45e2-bd41-8459a12480c7" } }, "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys (guid)", - "guid": "4c880eed-fc82-45c6-9971-0af1f27be100" + "name": "New name for replacement string" } }, "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Alloys (Layout)" + "value": "New value for replacement string" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "9ea460a1-7062-45e2-bd41-8459a12480c7" } }, "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys (guid)", - "guid": "4c880eed-fc82-45c6-9971-0af1f27be100" + "name": "New name for replacement string" } }, "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Alloys (Layout)" + "value": "New value for replacement string" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "9ea460a1-7062-45e2-bd41-8459a12480c7" } }, "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys (guid)", - "guid": "4c880eed-fc82-45c6-9971-0af1f27be100" + "name": "New name for replacement string" } }, "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Alloys (Layout)" + "value": "New value for replacement string" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateSubset" + "$ref": "#/components/schemas/GsaUpdateReplacementString" }, "examples": { "Example 1": { - "summary": "Subset", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a replacement string", + "description": "This example shows how to update all properties of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys" + "value": "New value for replacement string", + "name": "New name for replacement string", + "guid": "9ea460a1-7062-45e2-bd41-8459a12480c7" } }, "Example 2": { - "summary": "Subset with Guid", - "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Update name", + "description": "This example shows how to update the 'Name' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "name": "Alloys (guid)", - "guid": "4c880eed-fc82-45c6-9971-0af1f27be100" + "name": "New name for replacement string" } }, "Example 3": { - "summary": "Subset with associated layout", - "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", + "summary": "Update value", + "description": "This example shows how to update the 'Value' property of the 'Links to GRANTA MI support on the ANSYS Granta website' replacement string (guid = 0800f9b3-c48f-497e-a937-2e1af139055e) from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Alloys (Layout)" + "value": "New value for replacement string" } } } @@ -69391,21 +47701,17 @@ } }, "responses": { - "201": { - "description": "Created", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSubset" + "$ref": "#/components/schemas/GsaReplacementString" }, "example": { - "associatedLayout": { - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": {}, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + "value": "https://grantadesign.com/industry/support/granta-mi/{a:My Granta web folder}", + "name": "Links to GRANTA MI support on the ANSYS Granta website", + "guid": "0800f9b3-c48f-497e-a937-2e1af139055e" } } } @@ -69417,71 +47723,63 @@ "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database or replacement string not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}": { - "get": { + }, + "delete": { "tags": [ - "Schema - Subsets" + "Schema - Replacement Strings" ], - "summary": "Get a subset with a specified guid for a given database and table.", - "operationId": "GetSubset", + "summary": "Delete a replacement string", + "operationId": "DeleteReplacementString", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "description": "Database in which replacement string will be search for", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", + "name": "replacement-string-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "description": "Guid of replacement string to delete", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden." }, + "404": { + "description": "Database or replacement string not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/standard-names": { + "get": { + "tags": [ + "Schema - Standard Names" + ], + "summary": "Gets all standard names for a given database.", + "operationId": "GetStandardNames", + "parameters": [ { - "name": "subset-guid", + "name": "database-key", "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } } @@ -69492,68 +47790,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSubset" - }, - "example": { - "associatedLayout": { - "displayNames": { - "en": "Ceramics Layout English Display Name", - "fr": "Ceramics Layout French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + "$ref": "#/components/schemas/GsaStandardNamesInfo" } } } }, "404": { - "description": "Database, table or subset not found" + "description": "Database not found" } } }, - "patch": { + "post": { "tags": [ - "Schema - Subsets" + "Schema - Standard Names" ], - "summary": "Update a subset.", - "operationId": "UpdateSubset", + "summary": "Create a new standard name", + "operationId": "CreateStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "subset-guid", - "in": "path", "required": true, "schema": { - "type": "string", - "format": "uuid" + "type": "string" } } ], @@ -69561,164 +47820,324 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Ceramics (Updated)", - "guid": "28a7ae9d-cefa-4b94-824c-5723ee0a544d" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" } }, "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", "value": { - "name": "Ceramics (Updated)" + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" } }, "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" } }, "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", "value": { - "associatedLayout": null + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "2481079d-0d4a-4e71-a024-12c67103aed5" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Ceramics (Updated)", - "guid": "28a7ae9d-cefa-4b94-824c-5723ee0a544d" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" } }, "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", "value": { - "name": "Ceramics (Updated)" + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" } }, "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" } }, "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", "value": { - "associatedLayout": null + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "2481079d-0d4a-4e71-a024-12c67103aed5" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Ceramics (Updated)", - "guid": "28a7ae9d-cefa-4b94-824c-5723ee0a544d" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" } }, "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", "value": { - "name": "Ceramics (Updated)" + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" } }, "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" } }, "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", "value": { - "associatedLayout": null + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "2481079d-0d4a-4e71-a024-12c67103aed5" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateSubset" + "$ref": "#/components/schemas/GsaCreateStandardName" }, "examples": { "Example 1": { - "summary": "Everything for a subset", - "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for attributes", + "description": "This example demonstrates how to create a new standard name which maps to two attributes from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - }, - "name": "Ceramics (Updated)", - "guid": "28a7ae9d-cefa-4b94-824c-5723ee0a544d" + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "name": "Unification" } }, "Example 2": { - "summary": "Rename subset", - "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for parameters", + "description": "This example demonstrates how to create a new standard name which maps to two parameters from the MI_Training database.", "value": { - "name": "Ceramics (Updated)" + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ], + "name": "Unification" } }, "Example 3": { - "summary": "Update associated layout", - "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a record link group from the MI_Training database.", "value": { - "associatedLayout": { - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" - } + "mappedRecordLinkGroups": [ + { + "guid": "9337df8e-c22b-4aaf-a9fc-6930c69c94cb" + } + ], + "name": "Unification" } }, "Example 4": { - "summary": "Remove associated layout", - "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Standard name for cross-database record link groups", + "description": "This example demonstrates how to create a new standard name which maps to a cross-database record link group.", "value": { - "associatedLayout": null + "mappedCrossDatabaseRecordLinkGroups": [ + { + "guid": "2481079d-0d4a-4e71-a024-12c67103aed5" + } + ], + "name": "Unification" + } + }, + "Example 5": { + "summary": "Standard name for attributes and parameters", + "description": "This example demonstrates how to create a new standard name which maps to two attributes and a parameter from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + } + ], + "name": "Unification" } } } @@ -69726,28 +48145,12 @@ } }, "responses": { - "200": { - "description": "Ok", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSubset" - }, - "example": { - "associatedLayout": { - "displayNames": { - "en": "Ceramics Layout English Display Name", - "fr": "Ceramics Layout French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + "$ref": "#/components/schemas/GsaStandardName" } } } @@ -69759,41 +48162,29 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or subset not found" + "description": "Database not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/standard-names/{standard-name-guid}": { + "get": { "tags": [ - "Schema - Subsets" + "Schema - Standard Names" ], - "summary": "Delete a subset.", - "operationId": "DeleteSubset", + "summary": "Gets a standard name for a given database and guid.", + "operationId": "GetStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "subset-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { @@ -69804,52 +48195,37 @@ ], "responses": { "200": { - "description": "Ok" - }, - "400": { - "description": "Bad request" - }, - "403": { - "description": "Forbidden" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaStandardName" + } + } + } }, "404": { - "description": "Database, table or subset not found" + "description": "Database or standard name not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:add-to-subset": { - "post": { + }, + "patch": { "tags": [ - "Schema - Subsets" + "Schema - Standard Names" ], - "summary": "Add a record history to a subset.", - "operationId": "AddToSubset", + "summary": "Edit a standard name", + "operationId": "UpdateStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "subset-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { @@ -69862,92 +48238,200 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + "$ref": "#/components/schemas/GsaUpdateStandardName" }, "examples": { "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "name": "Density (Updated)" } }, "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "guid": "375aa92c-5590-45f6-bb5f-4088acf3852a" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + "$ref": "#/components/schemas/GsaUpdateStandardName" }, "examples": { "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "name": "Density (Updated)" } }, "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "guid": "375aa92c-5590-45f6-bb5f-4088acf3852a" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + "$ref": "#/components/schemas/GsaUpdateStandardName" }, "examples": { "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "name": "Density (Updated)" } }, "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "guid": "375aa92c-5590-45f6-bb5f-4088acf3852a" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] + } + }, + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + "$ref": "#/components/schemas/GsaUpdateStandardName" }, "examples": { "Example 1": { - "summary": "Add a Record History to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update name", + "description": "This example demonstrates how to update the 'Name' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": false + "name": "Density (Updated)" + } + }, + "Example 2": { + "summary": "Update guid", + "description": "This example demonstrates how to update the 'Guid' property of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "guid": "375aa92c-5590-45f6-bb5f-4088acf3852a" + } + }, + "Example 3": { + "summary": "Update mapped attributes", + "description": "This example demonstrates how to update the mapped attributes of the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", + "value": { + "mappedAttributes": [ + { + "guid": "000000b9-0001-4fff-8fff-dd92ffff0000" + }, + { + "guid": "000000ec-0001-4fff-8fff-dd92ffff0000" + } + ] } }, - "Example 2": { - "summary": "Add a Record History and its descendants to a Subset", - "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 4": { + "summary": "Replace mapped attributes with parameters", + "description": "This example demonstrates how to remove the mapped attribute and add mapped parameters to the 'Density' standard name (guid = 5f5b89f7-da4e-4ae2-8c65-485e3c1a98fd) from the MI_Training database.", "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", - "recurseChildren": true + "mappedAttributes": [], + "mappedParameters": [ + { + "guid": "00000001-000a-4fff-8fff-0000ffff0000" + }, + { + "guid": "b7cee874-160f-439a-a784-b887c516b2d5" + } + ] } } } @@ -69956,7 +48440,14 @@ }, "responses": { "200": { - "description": "OK" + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaStandardName" + } + } + } }, "400": { "description": "Bad request" @@ -69965,43 +48456,27 @@ "description": "Forbidden" }, "404": { - "description": "Database, table or subset not found" + "description": "Database or standard name not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:remove-from-subset": { - "post": { + }, + "delete": { "tags": [ - "Schema - Subsets" + "Schema - Standard Names" ], - "summary": "Remove a record history, and all of its descendants, from a subset.", - "operationId": "RemoveFromSubset", + "summary": "Delete a standard name.", + "operationId": "DeleteStandardName", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } }, { - "name": "subset-guid", + "name": "standard-name-guid", "in": "path", "required": true, "schema": { @@ -70010,99 +48485,45 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" - }, - "examples": { - "Example 1": { - "summary": "Remove a Record History from a Subset", - "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" - } - } - } - } - } - }, "responses": { "200": { - "description": "OK" + "description": "Ok" }, "400": { - "description": "Bad request" + "description": "Bad request." }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { - "description": "Database, table or subset not found" + "description": "Database or standard name not found." } } } }, - "/v1alpha/databases/{database-key}/tables": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets": { "get": { "tags": [ - "Schema - Tables" + "Schema - Subsets" ], - "summary": "Get all tables", - "operationId": "GetTables", + "summary": "Get all subsets for table", + "operationId": "GetSubsets", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { @@ -70136,37 +48557,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTablesInfo" + "$ref": "#/components/schemas/GsaSubsetsInfo" }, "example": { - "tables": [ + "subsets": [ { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [ - "Universe", - "Material" - ], "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" }, { - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "tableTypes": [ - "Design" - ], "displayNames": {}, - "name": "Design Data", - "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": {}, + "name": "Polymers", + "guid": "00007645-0010-4fff-8fff-dd92ffff0000" } ] } @@ -70174,26 +48585,32 @@ } }, "404": { - "description": "Database not found" + "description": "Database or table not found" } } }, "post": { "tags": [ - "Schema - Tables" + "Schema - Subsets" ], - "summary": "Create a new table.", - "operationId": "CreateTable", + "summary": "Create a new subset.", + "operationId": "CreateSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], @@ -70201,296 +48618,128 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateTable" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "name": "Alloys" } }, "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "033bde9f-44c3-4d68-a980-bd527117cdb0" + "name": "Alloys (guid)", + "guid": "40d0c959-0ed7-434a-9bb3-5078833efccb" } }, "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", - "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" - } - }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" - } - }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" - } - }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateTable" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "name": "Alloys" } }, "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "033bde9f-44c3-4d68-a980-bd527117cdb0" + "name": "Alloys (guid)", + "guid": "40d0c959-0ed7-434a-9bb3-5078833efccb" } }, "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", - "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" - } - }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" - } - }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" - } - }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaCreateTable" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "name": "Alloys" } }, "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "033bde9f-44c3-4d68-a980-bd527117cdb0" + "name": "Alloys (guid)", + "guid": "40d0c959-0ed7-434a-9bb3-5078833efccb" } }, "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", - "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" - } - }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" - } - }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" - } - }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaCreateTable" + "$ref": "#/components/schemas/GsaCreateSubset" }, "examples": { "Example 1": { - "summary": "Table", - "description": "This example demonstrates how to create a new table in the MI_Training database.", + "summary": "Subset", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings" + "name": "Alloys" } }, "Example 2": { - "summary": "Table with Guid", - "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "summary": "Subset with Guid", + "description": "This example demonstrates how to create a new subset with a specified guid value for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Guid)", - "guid": "033bde9f-44c3-4d68-a980-bd527117cdb0" + "name": "Alloys (guid)", + "guid": "40d0c959-0ed7-434a-9bb3-5078833efccb" } }, "Example 3": { - "summary": "Hidden Table", - "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", - "value": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Hidden)" - } - }, - "Example 4": { - "summary": "Table with legal disclaimer", - "description": "This example demonstrates how to create a new table with a legal disclaimer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Legal Disclaimer)" - } - }, - "Example 5": { - "summary": "Table with datasheet header and footer", - "description": "This example demonstrates how to create a new table with a datasheet header and datasheet footer.", - "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "name": "Coatings (Datasheet Header and Footer)" - } - }, - "Example 6": { - "summary": "Table with table type", - "description": "This example demonstrates how to create a new table with a table type of 'Coatings'.", + "summary": "Subset with associated layout", + "description": "This example demonstrates how to create a new subset for the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database with the 'Ceramics' layout associated.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "tableTypes": [ - "Coatings" - ], - "shouldShowVersionControlSignatures": false, - "name": "Coatings (with Table Type)" + "associatedLayout": { + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Alloys (Layout)" } } } @@ -70503,70 +48752,63 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTable" + "$ref": "#/components/schemas/GsaSubset" }, "example": { - "versionState": "unversioned", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [], + "associatedLayout": { + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, "displayNames": {}, - "name": "Material Universe", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableCreationException" - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}": { + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}": { "get": { "tags": [ - "Schema - Tables" + "Schema - Subsets" ], - "summary": "Get a table with a specified guid for a given database.", - "operationId": "GetTable", + "summary": "Get a subset with a specified guid for a given database and table.", + "operationId": "GetSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", "format": "uuid" } }, @@ -70601,131 +48843,62 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTable" + "$ref": "#/components/schemas/GsaSubset" }, "example": { - "defaultSubset": { - "name": "All bulk materials", - "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" - }, - "subsets": [ - { - "name": "Aerospace materials", - "guid": "0000fc72-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "All bulk materials", - "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" - }, - { - "name": "Polymers", - "guid": "00007645-0010-4fff-8fff-dd92ffff0000" - } - ], - "defaultLayout": { - "name": "All Attributes", - "guid": "384f9abe-0581-434d-a976-86952282207a" - }, - "layouts": [ - { - "name": "Aerospace materials", - "guid": "0000fc72-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "All Attributes", - "guid": "384f9abe-0581-434d-a976-86952282207a" - }, - { - "name": "All bulk materials", - "guid": "0000b1c5-0009-4fff-8fff-dd92ffff0000" - }, - { - "displayNames": { - "en": "Ceramics English Display Name", - "fr": "Ceramics French Display Name" - }, - "name": "Ceramics", - "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" - }, - { - "name": "Metals", - "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + "associatedLayout": { + "displayNames": { + "en": "Ceramics Layout English Display Name", + "fr": "Ceramics Layout French Display Name" }, - { - "name": "Polymers", - "guid": "00007645-0009-4fff-8fff-dd92ffff0000" - } - ], - "versionState": "unversioned", - "order": 0, - "qualitySystem": { - "name": "Test Data Quality System", - "guid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" }, - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": false, - "tableTypes": [ - "Material" - ], "displayNames": { - "en": "MaterialUniverse English Display Name", - "fr": "MaterialUniverse French Display Name" + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" }, - "name": "MaterialUniverse", - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" } } } }, "404": { - "description": "Database or table not found" + "description": "Database, table or subset not found" } } }, "patch": { "tags": [ - "Schema - Tables" + "Schema - Subsets" ], - "summary": "Update a table.", - "operationId": "UpdateTable", + "summary": "Update a subset.", + "operationId": "UpdateSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", "format": "uuid" } } @@ -70734,488 +48907,383 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "aa68642f-2c5a-42db-a34a-e84e8e44484a" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "7e457b05-43c2-49a9-8d1f-b51dbfed239e" } }, "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": true + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromSearch": false + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } } }, "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": null - } - }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "tableTypes": [ - "Material", - "Universal" - ] - } - }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", - "value": { - "shouldShowVersionControlSignatures": true - } - }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "qualitySystemGuid": null - } - }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "associatedLayout": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "aa68642f-2c5a-42db-a34a-e84e8e44484a" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "7e457b05-43c2-49a9-8d1f-b51dbfed239e" } }, "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": true + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromSearch": false + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } } }, "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": null - } - }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "tableTypes": [ - "Material", - "Universal" - ] - } - }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", - "value": { - "shouldShowVersionControlSignatures": true - } - }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "qualitySystemGuid": null - } - }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "associatedLayout": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "aa68642f-2c5a-42db-a34a-e84e8e44484a" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "7e457b05-43c2-49a9-8d1f-b51dbfed239e" } }, "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": true + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromSearch": false + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } } }, "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" - } - }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultLayoutGuid": null - } - }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." - } - }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "tableTypes": [ - "Material", - "Universal" - ] - } - }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", - "value": { - "shouldShowVersionControlSignatures": true - } - }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "qualitySystemGuid": null - } - }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "associatedLayout": null } } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaUpdateTable" + "$ref": "#/components/schemas/GsaUpdateSubset" }, "examples": { "Example 1": { - "summary": "Everything for a table", - "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Everything for a subset", + "description": "This example demonstrates how to update all properties of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": false, - "isHiddenFromSearch": true, - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb", - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data.", - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data.", - "datasheetFooter": "MI Training should only be used for training purposes. Any other use is not supported by Ansys Granta.", - "tableTypes": [ - "Material", - "Universal" - ], - "shouldShowVersionControlSignatures": true, - "name": "MaterialUniverse (Updated)", - "guid": "aa68642f-2c5a-42db-a34a-e84e8e44484a" + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + "name": "Ceramics (Updated)", + "guid": "7e457b05-43c2-49a9-8d1f-b51dbfed239e" } }, "Example 2": { - "summary": "Update 'IsHiddenFromBrowse'", - "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Rename subset", + "description": "This example demonstrates how to update the 'Name' property of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromBrowse": true + "name": "Ceramics (Updated)" } }, "Example 3": { - "summary": "Update 'IsHiddenFromSearch'", - "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Update associated layout", + "description": "This example demonstrates how to update associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "isHiddenFromSearch": false + "associatedLayout": { + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + } } }, "Example 4": { - "summary": "Update default subset", - "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" - } - }, - "Example 5": { - "summary": "Remove default subset", - "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", - "value": { - "defaultSubsetGuid": null - } - }, - "Example 6": { - "summary": "Update default layout", - "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "summary": "Remove associated layout", + "description": "This example demonstrates how to remove associated layout of the 'Ceramics' subset (guid = 00000b36-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + "associatedLayout": null } + } + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSubset" }, - "Example 7": { - "summary": "Remove default layout", - "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "example": { + "associatedLayout": { + "displayNames": { + "en": "Ceramics Layout English Display Name", + "fr": "Ceramics Layout French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" + }, + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or subset not found" + } + } + }, + "delete": { + "tags": [ + "Schema - Subsets" + ], + "summary": "Delete a subset.", + "operationId": "DeleteSubset", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database, table or subset not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:add-to-subset": { + "post": { + "tags": [ + "Schema - Subsets" + ], + "summary": "Add a record history to a subset.", + "operationId": "AddToSubset", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "defaultLayoutGuid": null + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false } }, - "Example 8": { - "summary": "Update legal disclaimer", - "description": "This example demonstrates how to update the legal disclaimer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "legalDisclaimer": "ANSYS, Inc. provides no warranty for this data." + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true } - }, - "Example 9": { - "summary": "Update datasheet header", - "description": "This example demonstrates how to update the datasheet header property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "datasheetHeader": "ANSYS, Inc. provides no warranty for this data." + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false } }, - "Example 10": { - "summary": "Update datasheet footer", - "description": "This example demonstrates how to update the datasheet footer property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "datasheetFooter": "ANSYS, Inc. provides no warranty for this data." + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true } - }, - "Example 11": { - "summary": "Update table type", - "description": "This example demonstrates how to update the table types property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "tableTypes": [ - "Material", - "Universal" - ] + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false } }, - "Example 12": { - "summary": "Update 'ShouldShowVersionControlSignatures'", - "description": "This example demonstrates how to update the 'ShouldShowVersionControlSignatures' property of the 'restricted Substances' table (guid = fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f) from the MI_Training database.", + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "shouldShowVersionControlSignatures": true + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true } - }, - "Example 13": { - "summary": "Remove quality system", - "description": "This example demonstrates how to remove the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaAddRecordHistoryToSubset" + }, + "examples": { + "Example 1": { + "summary": "Add a Record History to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History only (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "qualitySystemGuid": null + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": false } }, - "Example 14": { - "summary": "Update quality system", - "description": "This example demonstrates how to update the quality system property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "Example 2": { + "summary": "Add a Record History and its descendants to a Subset", + "description": "This example demonstrates how to add the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) and all of its descendants to the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "qualitySystemGuid": "a66c5a87-4779-44fe-85cf-d7c5f4b820eb" + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03", + "recurseChildren": true } } } @@ -71224,169 +49292,169 @@ }, "responses": { "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" - }, - "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ - { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ - { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "unreleased", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - } - } - } + "description": "OK" }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableUpdateException" - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database, table or subset not found" } } - }, - "delete": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}/subsets/{subset-guid}:remove-from-subset": { + "post": { "tags": [ - "Schema - Tables" + "Schema - Subsets" ], - "summary": "Delete a table.", - "operationId": "DeleteTable", + "summary": "Remove a record history, and all of its descendants, from a subset.", + "operationId": "RemoveFromSubset", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", + "format": "uuid" + } + }, + { + "name": "subset-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", "format": "uuid" } } ], - "responses": { - "400": { - "description": "Bad request. Table in use.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTableDeletionException" - }, - "example": { - "message": "Cannot delete table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", - "code": "deletion", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f", - "errors": [ - { - "message": "It is being used in one or more tabular attributes.", - "reason": "usage", - "referencedByType": "tabularAttribute", - "referencedBy": [ - { - "type": "tabular", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Restricted substances associated with this material", - "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" - } - ] - } - ] + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" + }, + "examples": { + "Example 1": { + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" + }, + "examples": { + "Example 1": { + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" + }, + "examples": { + "Example 1": { + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaRemoveRecordHistoryFromSubset" + }, + "examples": { + "Example 1": { + "summary": "Remove a Record History from a Subset", + "description": "This example demonstrates how to remove the 'Alumino Silicate' Record History (guid = 5a842e54-e143-45f5-aec8-18fb84f4fe03) from the 'All Bulk Materials' subset (guid = 0000b1c5-0010-4fff-8fff-dd92ffff0000) from the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "recordHistoryGuid": "5a842e54-e143-45f5-aec8-18fb84f4fe03" + } } } } - }, + } + }, + "responses": { "200": { - "description": "Ok" + "description": "OK" + }, + "400": { + "description": "Bad request" }, "403": { - "description": "Forbidden." + "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database, table or subset not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:release": { - "post": { + "/v1alpha/databases/{database-key}/tables": { + "get": { "tags": [ "Schema - Tables" ], - "summary": "Releases the table. Table must be version-controlled and unreleased.", - "operationId": "ReleaseTable", + "summary": "Get all tables", + "operationId": "GetTables", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -71396,217 +49464,264 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaTable" + "$ref": "#/components/schemas/GsaTablesInfo" }, "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ + "tables": [ { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "tableTypes": [ + "Universe", + "Material" + ], + "displayNames": { + "en": "MaterialUniverse English Display Name", + "fr": "MaterialUniverse French Display Name" + }, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" + }, { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "released", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", - "isHiddenFromBrowse": false, - "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" - } - } - } - }, - "400": { - "description": "Bad request. Table is not unreleased, or table is not version controlled.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaReleaseTableVersionControlException" - }, - "examples": { - "Example 1": { - "summary": "Invalid version state.", - "description": "A table can only be released if it is currently unreleased.", - "value": { - "message": "Cannot release table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", - "code": "releaseTableVersionControl", - "errors": [ - { - "message": "Invalid version state 'Released'.", - "reason": "invalidVersionState", - "versionState": "released" - } - ] - } - }, - "Example 2": { - "summary": "Table is not version controlled.", - "value": { - "message": "Cannot release table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", - "code": "releaseTableVersionControl", - "errors": [ - { - "message": "Table is not version controlled.", - "reason": "notVersioned" - } - ] + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "tableTypes": [ + "Design" + ], + "displayNames": {}, + "name": "Design Data", + "guid": "0000b5e2-0011-4fff-8fff-0000ffff0000" } - } + ] } } } }, - "403": { - "description": "Forbidden" - }, "404": { - "description": "Database or table not found" + "description": "Database not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:enable-version-control": { + }, "post": { "tags": [ "Schema - Tables" ], - "summary": "Enable version control on the table. This cannot be undone.\r\nAfter this method has been called all records and data in the table are in an unreleased state.\r\nThis means that read users will not be able to see any records unless they are subsequently released.", - "operationId": "EnableVersionControl", + "summary": "Create a new table.", + "operationId": "CreateTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "table-guid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" + "type": "string" } } ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaTable" + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateTable" + }, + "examples": { + "Example 1": { + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" + } }, - "example": { - "defaultSubset": { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - }, - "subsets": [ - { - "name": "All substances", - "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" - } - ], - "defaultLayout": { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - }, - "layouts": [ - { - "name": "All substances", - "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" - } - ], - "versionState": "unreleased", - "order": 0, - "shouldShowVersionControlSignatures": false, - "databaseKey": "MI_TRAINING", + "Example 2": { + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "53d3b0a2-c351-4e09-9e42-493d08735155" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "value": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateTable" + }, + "examples": { + "Example 1": { + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" + } + }, + "Example 2": { + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "53d3b0a2-c351-4e09-9e42-493d08735155" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "value": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" + } + } + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateTable" + }, + "examples": { + "Example 1": { + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" + } + }, + "Example 2": { + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "53d3b0a2-c351-4e09-9e42-493d08735155" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "value": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateTable" + }, + "examples": { + "Example 1": { + "summary": "Table", + "description": "This example demonstrates how to create a new table in the MI_Training database.", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings" + } + }, + "Example 2": { + "summary": "Table with Guid", + "description": "This example demonstrates how to create a new table with a specified guid value in the MI_Training database. Normally, if the guid is not specified, a random new Guid will be generated. ", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "name": "Coatings (Guid)", + "guid": "53d3b0a2-c351-4e09-9e42-493d08735155" + } + }, + "Example 3": { + "summary": "Hidden Table", + "description": "This example demonstrates how to create a new table in the MI_Training database that is not browsable or searchable. ", + "value": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "name": "Coatings (Hidden)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaTable" + }, + "example": { + "versionState": "unversioned", "isHiddenFromBrowse": false, "isHiddenFromSearch": false, - "isVersioned": true, - "name": "Restricted Substances", - "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" + "isVersioned": false, + "tableTypes": [], + "displayNames": {}, + "name": "Material Universe", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" } } } }, "400": { - "description": "Bad request. Table is already versioned." + "description": "Bad request" }, "403": { "description": "Forbidden" }, "404": { - "description": "Database or table not found" + "description": "Database not found" } } } }, - "/v1alpha/databases/{database-key}/tables/{table-guid}:inbound-links": { - "post": { + "/v1alpha/databases/{database-key}/tables/{table-guid}": { + "get": { "tags": [ "Schema - Tables" ], - "summary": "Get all record link groups and tabular attributes pointing towards the table.", - "operationId": "GetInboundLinks", + "summary": "Get a table with a specified guid for a given database.", + "operationId": "GetTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, - { - "name": "type", - "in": "query", - "description": "The link types to include in the response. If not provided, all link types are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - } - } - }, { "name": "mode", "in": "query", @@ -71638,122 +49753,83 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaLinksInfo" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "links": [ + "defaultSubset": { + "name": "All bulk materials", + "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" + }, + "subsets": [ { - "type": "recordLink", - "includeIndirectLinks": false, - "reverseName": "Training Exercise", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": {}, - "name": "MaterialUniverse", - "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + "name": "Aerospace materials", + "guid": "0000fc72-0010-4fff-8fff-dd92ffff0000" + }, + { + "name": "All bulk materials", + "guid": "0000b1c5-0010-4fff-8fff-dd92ffff0000" }, { - "type": "smartLink", - "forbidOrphans": false, - "referentialIntegrityModel": "manyToMany", - "attributePairs": [ - { - "attributeSource": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "9bd8599e-36e0-4008-b52e-2f70b90c00a0" - }, - "attributeTarget": { - "targetType": "resolved", - "name": "Base", - "displayNames": {}, - "attributeType": "discrete", - "guid": "000001cb-0001-4fff-8fff-dd92ffff0000" - } - } - ], - "reverseName": "Smart Link to Training Record", - "reverseDisplayNames": { - "en": "en-Smart Link to Training Record", - "fr": "fr-Smart Link to Training Record" - }, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, "displayNames": { - "en": "en-Smart Link to MaterialUniverse", - "fr": "fr-Smart Link to MaterialUniverse" + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" }, - "name": "Smart Link to MaterialUniverse", - "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" + "name": "Ceramics", + "guid": "00000b36-0010-4fff-8fff-dd92ffff0000" }, { - "type": "crossDatabaseLink", - "includeIndirectLinks": false, - "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "cb06018a-fd29-4a1f-b1aa-71b570fc072e", - "databaseVersionGuid": "966d8232-9547-4c4e-ab55-5a84763ea24e", - "tableGuid": "f8a2eebd-03ba-4dfe-bc0d-9deac2e09236" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } - }, - "displayNames": {}, - "name": "Cross database link group : Second Training Database And Table - MI Training MaterialUniverse", - "guid": "eae6fddb-7e0e-435f-bd09-1141389af301" + "name": "Metals", + "guid": "0000b135-0010-4fff-8fff-dd92ffff0000" }, { - "type": "tabularAttribute", - "targetAttribute": { - "guid": "00000099-0001-4fff-8fff-dd92ffff0000" - }, - "reverseName": "Environmental performances overview", - "reverseDisplayNames": {}, - "linkInfo": { - "linkSource": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "linkTarget": { - "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", - "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", - "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" - } + "name": "Polymers", + "guid": "00007645-0010-4fff-8fff-dd92ffff0000" + } + ], + "defaultLayout": { + "name": "All Attributes", + "guid": "384f9abe-0581-434d-a976-86952282207a" + }, + "layouts": [ + { + "name": "Aerospace materials", + "guid": "0000fc72-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "All Attributes", + "guid": "384f9abe-0581-434d-a976-86952282207a" + }, + { + "name": "All bulk materials", + "guid": "0000b1c5-0009-4fff-8fff-dd92ffff0000" + }, + { + "displayNames": { + "en": "Ceramics English Display Name", + "fr": "Ceramics French Display Name" }, - "displayNames": {}, - "name": "Environmental performances overview", - "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" + "name": "Ceramics", + "guid": "00000b36-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "Metals", + "guid": "0000b135-0009-4fff-8fff-dd92ffff0000" + }, + { + "name": "Polymers", + "guid": "00007645-0009-4fff-8fff-dd92ffff0000" } - ] + ], + "versionState": "unversioned", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": false, + "displayNames": { + "en": "MaterialUniverse English Display Name", + "fr": "MaterialUniverse French Display Name" + }, + "name": "MaterialUniverse", + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" } } } @@ -71762,49 +49838,29 @@ "description": "Database or table not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables:query": { - "post": { + }, + "patch": { "tags": [ "Schema - Tables" ], - "summary": "Gets tables for a given database, populates the requested properties.", - "operationId": "QueryTables", + "summary": "Update a table.", + "operationId": "UpdateTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], "type": "string" } }, { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "name": "table-guid", + "in": "path", + "required": true, "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" + "type": "string", + "format": "uuid" } } ], @@ -71812,208 +49868,244 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Fetch all tables with custom properties", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aeb6c74f-667b-4925-843a-fd5b238cf215" } }, "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null } } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Fetch all tables with custom properties", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aeb6c74f-667b-4925-843a-fd5b238cf215" } }, "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null } } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" + "$ref": "#/components/schemas/GsaUpdateTable" }, "examples": { "Example 1": { - "summary": "Fetch all tables with custom properties", + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aeb6c74f-667b-4925-843a-fd5b238cf215" } }, "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": null + } + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" + } + }, + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultLayoutGuid": null + } + } + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaUpdateTable" + }, + "examples": { + "Example 1": { + "summary": "Everything for a table", + "description": "This example demonstrates how to update all properties of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": false, + "isHiddenFromSearch": true, + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000", + "name": "MaterialUniverse (Updated)", + "guid": "aeb6c74f-667b-4925-843a-fd5b238cf215" + } + }, + "Example 2": { + "summary": "Update 'IsHiddenFromBrowse'", + "description": "This example demonstrates how to update the 'IsHiddenFromBrowse' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromBrowse": true + } + }, + "Example 3": { + "summary": "Update 'IsHiddenFromSearch'", + "description": "This example demonstrates how to update the 'IsHiddenFromSearch' property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "isHiddenFromSearch": false + } + }, + "Example 4": { + "summary": "Update default subset", + "description": "This example demonstrates how to update the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", + "value": { + "defaultSubsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000" + } + }, + "Example 5": { + "summary": "Remove default subset", + "description": "This example demonstrates how to remove the default subset property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "defaultSubsetGuid": null } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaQueryTablesRequest" - }, - "examples": { - "Example 1": { - "summary": "Fetch all tables with custom properties", + }, + "Example 6": { + "summary": "Update default layout", + "description": "This example demonstrates how to update the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "isHiddenFromBrowse": true, - "isHiddenFromSearch": true, - "isVersioned": true, - "versionState": true, - "tableTypes": true, - "layouts": { - "name": true, - "guid": true - }, - "defaultLayout": { - "name": true, - "guid": true - }, - "subsets": { - "name": true, - "guid": true - }, - "defaultSubset": { - "name": true, - "guid": true - }, - "displayNames": true, - "name": true, - "guid": true - } + "defaultLayoutGuid": "00000b36-0009-4fff-8fff-dd92ffff0000" } }, - "Example 2": { - "summary": "Fetch table with name \"MaterialUniverse\"", + "Example 7": { + "summary": "Remove default layout", + "description": "This example demonstrates how to remove the default layout property of the 'MaterialUniverse' table (guid = 0000dd92-0011-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "properties": { - "name": true, - "guid": true - }, - "filter": { - "name": [ - "MaterialUniverse" - ] - } + "defaultLayoutGuid": null } } } @@ -72026,7 +50118,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaQueryTablesInfo" + "$ref": "#/components/schemas/GsaTable" + }, + "example": { + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + }, + "subsets": [ + { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + } + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + }, + "layouts": [ + { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + } + ], + "versionState": "unreleased", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } @@ -72034,99 +50154,64 @@ "400": { "description": "Bad request" }, + "403": { + "description": "Forbidden" + }, "404": { - "description": "Database not found" + "description": "Database or table not found" } } - } - }, - "/v1alpha/databases/{database-key}/tables/{table-guid}/permission-category-access-controls": { - "get": { + }, + "delete": { "tags": [ "Schema - Tables" ], - "summary": "Get permission-based access control settings for a given table.\r\nReturns the access control for each permission in each category.", - "operationId": "GetTablePermissionCategoryAccessControls", + "summary": "Delete a table.", + "operationId": "DeleteTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } ], "responses": { - "200": { - "description": "Ok", + "400": { + "description": "Bad request. Table in use.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaTableDeletionException" }, "example": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, + "message": "Cannot delete table 'Restricted Substances' (GUID = 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f').", + "code": 400, + "errors": [ { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, + "message": "It is being used in one or more tabular attributes.", + "reason": "usage", + "referencedByType": "tabularAttribute", + "referencedBy": [ { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" + "type": "tabular", + "isHiddenFromSearchCriteria": false, + "table": { + "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" }, - "canRead": true, - "canWrite": true + "name": "Restricted substances associated with this material", + "guid": "51e51832-0bcc-4fe0-bb95-ddd6917dc554" } ] } @@ -72135,584 +50220,267 @@ } } }, + "200": { + "description": "Ok" + }, "403": { - "description": "Forbidden" + "description": "Forbidden." }, "404": { "description": "Database or table not found" - }, - "422": { - "description": "MI not in permission-based access control mode" } } - }, - "patch": { + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:release": { + "post": { "tags": [ "Schema - Tables" ], - "summary": "Update permission-based access control settings for a given table.\r\nSets the access control for the given permissions.", - "operationId": "UpdateTablePermissionCategoryAccessControls", + "summary": "Releases the table. Table must be version-controlled and unreleased.", + "operationId": "ReleaseTable", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControlRequest" - }, - "examples": { - "Example 9": { - "summary": "Update write access for a single permission", - "description": "This example demonstrates how to update write access for the US permission in the Geo category.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canWrite": true - } - ] - } - ] - } - }, - "Example 10": { - "summary": "Multiple permissions", - "description": "This example demonstrates how to update read and write access for multiple permissions across different permission categories.", - "value": { - "categoryAccessControls": [ - { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": true, - "canWrite": true - } - ] - }, - { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] - } - ] - } - } - } - } - } - }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControlInfo" + "$ref": "#/components/schemas/GsaTable" }, "example": { - "categoryAccessControls": [ + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + }, + "subsets": [ { - "category": { - "guid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "41a93859-0de1-46dc-9dea-0fb464be83a7" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "0e175b38-fb09-49c7-ab38-9bcc9fd31f79" - }, - "canRead": true, - "canWrite": true - }, - { - "permission": { - "guid": "d996b960-2dbd-4fbf-aa2e-4e2f1622f69a" - }, - "canRead": false, - "canWrite": false - } - ] - }, + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" + } + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" + }, + "layouts": [ { - "category": { - "guid": "8959572f-1b47-456b-852f-d14cb2dc59a6" - }, - "permissionAccessControls": [ - { - "permission": { - "guid": "1d27f2f6-2d33-4ad8-ad7f-e0333f6c7ffe" - }, - "canRead": true, - "canWrite": false - }, - { - "permission": { - "guid": "fa9a73a6-bf20-4f0e-8fa1-30d69959cafa" - }, - "canRead": true, - "canWrite": true - } - ] + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" } - ] + ], + "versionState": "released", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } }, "400": { - "description": "Bad request", + "description": "Bad request. Table is not unreleased, or table is not version controlled.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlUpdateException" + "$ref": "#/components/schemas/GsaReleaseTableVersionControlException" }, "examples": { - "Example 17": { - "summary": "Permission category not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission category with GUID '42012cfa-3b68-42c1-8d8c-dbe21fce912f', but the permission category does not exist.", + "Example 1": { + "summary": "Invalid version state.", + "description": "A table can only be released if it is currently unreleased.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", + "message": "Cannot release table with GUID 'fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f'.", + "code": 400, "errors": [ { - "message": "The permission category with GUID '42012cfa-3b68-42c1-8d8c-dbe21fce912f' does not exist.", - "categoryGuid": "42012cfa-3b68-42c1-8d8c-dbe21fce912f", - "reason": "noSuchCategory" + "message": "Invalid version state 'Released'.", + "reason": "invalidVersionState", + "versionState": "released" } ] } }, - "Example 18": { - "summary": "Permission not found", - "description": "This example demonstrates an error response returned for an invalid request that attempted to update access controls for a permission with GUID '5b3c0ea9-ebc9-44f4-bef6-f92955484af9' in the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e', but the permission does not exist in that category.", + "Example 2": { + "summary": "Table is not version controlled.", "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", + "message": "Cannot release table with GUID '0000dd92-0011-4fff-8fff-0000ffff0000'.", + "code": 400, "errors": [ { - "message": "The permission with GUID '5b3c0ea9-ebc9-44f4-bef6-f92955484af9' in permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' does not exist.", - "permissionGuid": "5b3c0ea9-ebc9-44f4-bef6-f92955484af9", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "reason": "noSuchPermission" + "message": "Table is not version controlled.", + "reason": "notVersioned" } ] } + } + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Database or table not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/tables/{table-guid}:enable-version-control": { + "post": { + "tags": [ + "Schema - Tables" + ], + "summary": "Enable version control on the table. This cannot be undone.\r\nAfter this method has been called all records and data in the table are in an unreleased state.\r\nThis means that read users will not be able to see any records unless they are subsequently released.", + "operationId": "EnableVersionControl", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaTable" + }, + "example": { + "defaultSubset": { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" }, - "Example 19": { - "summary": "Duplicate category GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e' more than once.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission category GUIDs allowed. Duplicated GUIDs: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'", - "duplicateGuids": [ - "aceedc4e-bd29-44bc-8956-7e1d98468c7e" - ], - "reason": "duplicateCategoryGuids" - } - ] + "subsets": [ + { + "name": "All substances", + "guid": "883ab52b-01b6-4a15-a89a-2bfa17c8d0e9" } + ], + "defaultLayout": { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" }, - "Example 20": { - "summary": "Duplicate permission GUIDs", - "description": "This example demonstrates an error response returned for an invalid request that specified the 'US' permission with GUID '41a93859-0de1-46dc-9dea-0fb464be83a7' more than once within the 'Geo' permission category with GUID 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'.", - "value": { - "message": "Cannot update access control for permission categories.", - "code": "permissionCategoriesAccessControlUpdate", - "errors": [ - { - "message": "No duplicate permission GUIDs allowed within a category. Category GUID: 'aceedc4e-bd29-44bc-8956-7e1d98468c7e'. Duplicated GUIDs: '41a93859-0de1-46dc-9dea-0fb464be83a7'", - "categoryGuid": "aceedc4e-bd29-44bc-8956-7e1d98468c7e", - "duplicateGuids": [ - "41a93859-0de1-46dc-9dea-0fb464be83a7" - ], - "reason": "duplicatePermissionGuids" - } - ] + "layouts": [ + { + "name": "All substances", + "guid": "bdd30b01-f9bc-4024-a1de-55956c8f2e5c" } - } + ], + "versionState": "unreleased", + "isHiddenFromBrowse": false, + "isHiddenFromSearch": false, + "isVersioned": true, + "name": "Restricted Substances", + "guid": "fa7aff0f-cac8-4c1d-be1f-d3b83f0ed74f" } } } }, + "400": { + "description": "Bad request. Table is already versioned." + }, "403": { "description": "Forbidden" }, "404": { "description": "Database or table not found" - }, - "422": { - "description": "MI not in permission-based access control mode" } } } }, - "/v1alpha/databases/{database-key}/unit-equivalents": { - "get": { + "/v1alpha/databases/{database-key}/tables/{table-guid}:inbound-links": { + "post": { "tags": [ - "Schema - Unit Equivalents" + "Schema - Tables" ], - "summary": "Get unit equivalents", - "operationId": "GetUnitEquivalents", + "summary": "Get all record link groups and tabular attributes pointing towards the table.", + "operationId": "GetInboundLinks", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "table-guid", + "in": "path", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } }, { - "name": "unit", + "name": "type", "in": "query", + "description": "The link types to include in the response. If not provided, all link types are included.", "schema": { "type": "array", "items": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/GsaLinkAttributeType" } } }, { - "name": "unitSystem", + "name": "mode", "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -72722,72 +50490,149 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" + "$ref": "#/components/schemas/GsaLinksInfo" }, "example": { - "unitEquivalents": [ + "links": [ { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "identity": 115, + "type": "recordLink", + "reverseName": "Training Exercise", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } + }, + "displayNames": {}, + "name": "MaterialUniverse", + "guid": "00e07ec0-695e-4ca3-bf1d-3bbeef126949" + }, + { + "identity": 3, + "type": "dynamicLink", + "reverseName": "Smart Link to Training Record", + "reverseDisplayNames": { + "en": "en-Smart Link to Training Record", + "fr": "fr-Smart Link to Training Record" + }, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } }, - "unitSystem": { - "guid": "00000001-0014-4fff-8fff-0000ffff0000" + "displayNames": { + "en": "en-Smart Link to MaterialUniverse", + "fr": "fr-Smart Link to MaterialUniverse" }, - "equivalentUnit": { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } + "name": "Smart Link to MaterialUniverse", + "guid": "7bf0d4d5-6896-4a10-b7a1-d1fe4e533e66" }, { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "identity": 1, + "type": "crossDatabaseLink", + "reverseName": "Cross database link group : MI Training MaterialUniverse - Second Training Database And Table", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "612d64fe-e320-4e58-9f8f-7d20c7b2bc68", + "databaseVersionGuid": "1121fef1-6e47-4d31-a083-cbcc70ede6e2", + "tableGuid": "7c522f07-fa22-42fa-b679-50e77995e760" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } }, - "unitSystem": { - "guid": "00000007-0014-4fff-8fff-0000ffff0000" + "displayNames": {}, + "name": "Cross database link group : Second Training Database And Table - MI Training MaterialUniverse", + "guid": "3929c712-bb5f-4307-9db2-5096b1751bc9" + }, + { + "identity": 8944, + "type": "tabularAttribute", + "reverseName": "Environmental performances overview", + "reverseDisplayNames": {}, + "linkInfo": { + "linkSource": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" + }, + "linkTarget": { + "databaseGuid": "43a43640-4919-428a-bac9-16efbc4ce6ed", + "databaseVersionGuid": "feead34a-cc0e-4070-bbc0-647654a25407", + "tableGuid": "0000dd92-0011-4fff-8fff-0000ffff0000" + } }, - "equivalentUnit": { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } + "displayNames": {}, + "name": "Environmental performances overview", + "guid": "2523a67a-6246-4c9e-8583-15b64d6290e5" } ] } } } }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaGetUnitEquivalentsException" - } - } - } - }, "404": { - "description": "Database not found" + "description": "Database or table not found" } } } }, - "/v1alpha/databases/{database-key}/unit-equivalents:update": { + "/v1alpha/databases/{database-key}/tables:query": { "post": { "tags": [ - "Schema - Unit Equivalents" + "Schema - Tables" ], - "summary": "Update one or more unit equivalents.\r\nReturns the unit equivalents that have been updated.", - "operationId": "SetUnitEquivalents", + "summary": "Gets tables for a given database, populates the requested properties.", + "operationId": "QueryTables", "parameters": [ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" + } + }, + { + "name": "mode", + "in": "query", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" + } + }, + { + "name": "X-Ansys-VC-Mode", + "in": "header", + "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", + "schema": { + "enum": [ + "read", + "write" + ], + "type": "string" } } ], @@ -72795,77 +50640,227 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" + "$ref": "#/components/schemas/GsaQueryTablesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all tables with custom properties", + "value": { + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch table with name \"MaterialUniverse\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" + "$ref": "#/components/schemas/GsaQueryTablesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all tables with custom properties", + "value": { + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch table with name \"MaterialUniverse\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } + } + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" + "$ref": "#/components/schemas/GsaQueryTablesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all tables with custom properties", + "value": { + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true + }, + "defaultLayout": { + "name": true, + "guid": true + }, + "subsets": { + "name": true, + "guid": true + }, + "defaultSubset": { + "name": true, + "guid": true + }, + "displayNames": true, + "name": true, + "guid": true + } + } + }, + "Example 2": { + "summary": "Fetch table with name \"MaterialUniverse\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } + } + } } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsInfo" - } - } - } - }, - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" - }, - "example": { - "unitEquivalents": [ - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "$ref": "#/components/schemas/GsaQueryTablesRequest" + }, + "examples": { + "Example 1": { + "summary": "Fetch all tables with custom properties", + "value": { + "properties": { + "isHiddenFromBrowse": true, + "isHiddenFromSearch": true, + "isVersioned": true, + "versionState": true, + "tableTypes": true, + "layouts": { + "name": true, + "guid": true }, - "unitSystem": { - "guid": "00000001-0014-4fff-8fff-0000ffff0000" + "defaultLayout": { + "name": true, + "guid": true }, - "equivalentUnit": { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" + "subsets": { + "name": true, + "guid": true }, - "unitSystem": { - "guid": "00000007-0014-4fff-8fff-0000ffff0000" + "defaultSubset": { + "name": true, + "guid": true }, - "equivalentUnit": { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } + "displayNames": true, + "name": true, + "guid": true } - ] + } + }, + "Example 2": { + "summary": "Fetch table with name \"MaterialUniverse\"", + "value": { + "properties": { + "name": true, + "guid": true + }, + "filter": { + "name": [ + "MaterialUniverse" + ] + } + } } } } - }, - "400": { - "description": "Bad request", + } + }, + "responses": { + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSetUnitEquivalentsException" + "$ref": "#/components/schemas/GsaQueryTablesInfo" } } } }, - "403": { - "description": "Forbidden" + "400": { + "description": "Bad request" }, "404": { "description": "Database not found" @@ -72884,12 +50879,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -72904,7 +50896,7 @@ "summary": "Convert units", "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", "value": { - "conversions": [ + "sourceUnits": [ { "sourceUnitSymbol": "K", "targetUnitSymbol": "°F" @@ -72923,7 +50915,7 @@ "summary": "Convert units", "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", "value": { - "conversions": [ + "sourceUnits": [ { "sourceUnitSymbol": "K", "targetUnitSymbol": "°F" @@ -72942,7 +50934,7 @@ "summary": "Convert units", "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", "value": { - "conversions": [ + "sourceUnits": [ { "sourceUnitSymbol": "K", "targetUnitSymbol": "°F" @@ -72961,7 +50953,7 @@ "summary": "Convert units", "description": "This example demonstrates how to request the unit conversions of Kelvin to Fahrenheit in the MI_Training database.", "value": { - "conversions": [ + "sourceUnits": [ { "sourceUnitSymbol": "K", "targetUnitSymbol": "°F" @@ -72983,9 +50975,103 @@ } } } + } + } + } + }, + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units": { + "get": { + "tags": [ + "Schema - Units" + ], + "summary": "Get equivalent units (one per unit system)", + "operationId": "GetUnitEquivalents", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "400": { - "description": "Bad request" + { + "name": "unit-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaUnitEquivalentsInfo" + } + } + } + }, + "404": { + "description": "Database or unit not found" + } + } + } + }, + "/v1alpha/databases/{database-key}/units/{unit-guid}/equivalent-units/unit-system/{unit-system-guid}/equivalent-unit/{equivalent-unit-guid}:set-equivalent-unit": { + "post": { + "tags": [ + "Schema - Units" + ], + "summary": "Set the equivalent unit for a given unit system", + "operationId": "SetUnitEquivalent", + "parameters": [ + { + "name": "database-key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "unit-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "unit-system-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "equivalent-unit-guid", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "404": { + "description": "Database, unit system, unit or equivalent unit not found" } } } @@ -73001,12 +51087,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -73017,29 +51100,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnitsInfo" - }, - "examples": { - "Example 1": { - "summary": "Units", - "description": "Example of units from the MI Training database", - "value": { - "units": [ - { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - ] - } - } } } } @@ -73059,12 +51119,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -73073,109 +51130,21 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "89dfc241-ce26-4305-810d-037014626041" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "310a7750-8f7c-4519-8c46-4bcb77770958" - } - } } }, "application/json": { "schema": { "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "89dfc241-ce26-4305-810d-037014626041" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "310a7750-8f7c-4519-8c46-4bcb77770958" - } - } } }, "text/json": { "schema": { "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "89dfc241-ce26-4305-810d-037014626041" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "310a7750-8f7c-4519-8c46-4bcb77770958" - } - } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GsaCreateUnit" - }, - "examples": { - "Example 1": { - "summary": "Create a simple unit", - "description": "An example request to create a simple unit.", - "value": { - "symbol": "newu", - "equation": "", - "name": "new unit", - "guid": "89dfc241-ce26-4305-810d-037014626041" - } - }, - "Example 2": { - "summary": "Create a unit with an equation", - "description": "An example request to create a unit with an equation to define it in terms of another unit.", - "value": { - "symbol": "newue", - "equation": "0.01*[m]", - "name": "new unit with equation", - "guid": "310a7750-8f7c-4519-8c46-4bcb77770958" - } - } } } } @@ -73187,106 +51156,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 3": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 4": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitCreationException" - }, - "examples": { - "Example 1": { - "summary": "Empty symbol", - "description": "The unit symbol was not provided or is empty.", - "value": { - "message": "Cannot create unit 'NewUnit'", - "code": "unitCreation", - "name": "NewUnit", - "errors": [ - { - "message": "Unit must have a symbol", - "reason": "emptySymbol" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate symbol", - "description": "A unit with the same symbol already exists in the database.", - "value": { - "message": "Cannot create unit 'Kilogram'", - "code": "unitCreation", - "name": "Kilogram", - "errors": [ - { - "message": "A unit with the symbol 'kg' already exists.", - "symbol": "kg", - "reason": "duplicateSymbol" - } - ] - } - }, - "Example 3": { - "summary": "Name already exists", - "description": "A unit with the same name already exists.", - "value": { - "message": "Cannot create unit 'Kilogram'", - "code": "unitCreation", - "name": "Kilogram", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Unit with name 'Kilogram' already exists.", - "name": "Kilogram", - "reason": "nameAlreadyExists", - "entityType": "unit" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The required property 'name' was not provided.", - "value": { - "message": "CreateUnit: Required property 'name' not found in JSON", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" @@ -73308,12 +51183,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -73333,29 +51205,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 1": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 2": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } } } } @@ -73375,12 +51224,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -73398,177 +51244,21 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "5491ec78-101a-4d9e-b480-c8119c907228" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } } }, "application/json": { "schema": { "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "5491ec78-101a-4d9e-b480-c8119c907228" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } } }, "text/json": { "schema": { "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "5491ec78-101a-4d9e-b480-c8119c907228" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GsaUpdateUnit" - }, - "examples": { - "Example 1": { - "summary": "Update name", - "description": "This example demonstrates how to update the 'Name' property of a unit.", - "value": { - "name": "metre (Updated)" - } - }, - "Example 2": { - "summary": "Update symbol", - "description": "This example demonstrates how to update the 'Symbol' property of a unit.", - "value": { - "symbol": "m2" - } - }, - "Example 3": { - "summary": "Update guid", - "description": "This example demonstrates how to update the 'Guid' property of a unit.", - "value": { - "guid": "5491ec78-101a-4d9e-b480-c8119c907228" - } - }, - "Example 4": { - "summary": "Update equation", - "description": "This example demonstrates how to update the 'Equation' property of a unit to define it in terms of another unit.", - "value": { - "equation": "0.01*[strain]" - } - }, - "Example 5": { - "summary": "Update multiple properties", - "description": "This example demonstrates how to update multiple properties of a unit in a single request.", - "value": { - "symbol": "% strain", - "equation": "0.01*[strain]", - "name": "% strain (Updated)" - } - } } } } @@ -73580,106 +51270,12 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnit" - }, - "examples": { - "Example 7": { - "summary": "Unit with equation", - "description": "Example of the inch unit from the MI Training database which contains an equation", - "value": { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - }, - "Example 8": { - "summary": "Unit with relative symbol", - "description": "Example of the Kelvin unit from the MI Training database which contains a relative symbol", - "value": { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - } - } } } } }, "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitUpdateException" - }, - "examples": { - "Example 1": { - "summary": "Empty symbol", - "description": "The unit symbol was set to an empty value.", - "value": { - "message": "Cannot update unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "Unit must have a symbol", - "reason": "emptySymbol" - } - ] - } - }, - "Example 2": { - "summary": "Duplicate symbol", - "description": "A unit with the same symbol already exists in the database.", - "value": { - "message": "Cannot update unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "A unit with the symbol 'kg' already exists.", - "symbol": "kg", - "reason": "duplicateSymbol" - } - ] - } - }, - "Example 3": { - "summary": "Name already exists", - "description": "A unit with the same name already exists.", - "value": { - "message": "Cannot update unit '0000007a-0013-4fff-8fff-0000ffff0000'", - "code": "unitUpdate", - "guid": "0000007a-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "The name or GUID is not valid.", - "errors": [ - { - "message": "Unit with name 'Kilogram' already exists.", - "name": "Kilogram", - "reason": "nameAlreadyExists", - "entityType": "unit" - } - ], - "reason": "namedEntity" - } - ] - } - }, - "Example 4": { - "summary": "Invalid JSON", - "description": "The JSON body could not be deserialized.", - "value": { - "message": "UpdateUnit: Invalid JSON in request body", - "code": "jsonSerialization" - } - } - } - } - } + "description": "Bad request" }, "403": { "description": "Forbidden" @@ -73699,12 +51295,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -73718,59 +51311,12 @@ } ], "responses": { - "400": { - "description": "Bad request. A unit cannot be deleted if it is used in an attribute, parameter, constant, expression, local tabular column, in the equation of another unit, or as the database currency unit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitDeletionException" - }, - "examples": { - "Example 1": { - "summary": "Used by attributes", - "description": "The unit cannot be deleted, because it is used by the following attributes: 'Yield Strength (elastic limit)' with GUID '0000011b-0001-4fff-8fff-dd92ffff0000' in the 'MaterialUniverse' table (GUID '0000dd92-0011-4fff-8fff-0000ffff0000'), and 'Yield Strength' with GUID '2b233cf4-fd42-4ab0-b8de-2227c9b71248' in the 'Training Exercise for Import' table (GUID '0404f83b-64fb-47b1-8f3c-3388c513c9b0')", - "value": { - "message": "Cannot delete unit with GUID '0000002b-0013-4fff-8fff-0000ffff0000'.", - "code": "deletion", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000", - "errors": [ - { - "message": "It is being used in one or more attributes.", - "reason": "usage", - "referencedByType": "attribute", - "referencedBy": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Yield Strength (elastic limit)", - "guid": "0000011b-0001-4fff-8fff-dd92ffff0000" - }, - { - "type": "point", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0404f83b-64fb-47b1-8f3c-3388c513c9b0" - }, - "name": "Yield Strength", - "guid": "2b233cf4-fd42-4ab0-b8de-2227c9b71248" - } - ] - } - ] - } - } - } - } - } - }, "200": { "description": "Ok" }, + "400": { + "description": "Bad request" + }, "403": { "description": "Forbidden" }, @@ -73791,12 +51337,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -73816,29 +51359,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnitsInfo" - }, - "examples": { - "Example 1": { - "summary": "Units", - "description": "Example of units from the MI Training database", - "value": { - "units": [ - { - "equation": "", - "name": "Temperature (Kelvin/Celsius)", - "symbol": "K", - "relativeSymbol": "°C", - "guid": "00000002-0013-4fff-8fff-0000ffff0000" - }, - { - "equation": "0.0254*[m]", - "name": "inch", - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - } - ] - } - } } } } @@ -73860,12 +51380,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -73876,17 +51393,6 @@ "type": "string", "format": "uuid" } - }, - { - "name": "response-filters", - "in": "query", - "description": "The unit usage types to include in the response. If none are provided, all types are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitUsageType" - } - } } ], "responses": { @@ -73896,41 +51402,6 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GsaUnitUsage" - }, - "examples": { - "Example 1": { - "summary": "Unit usage", - "description": "Displays some example usages of the unit Kelvin in the MI Training database. ", - "value": { - "attributes": [ - { - "type": "range", - "isHiddenFromSearchCriteria": false, - "isProtected": false, - "table": { - "guid": "0000dd92-0011-4fff-8fff-0000ffff0000" - }, - "name": "Melting point", - "guid": "0000000d-0001-4fff-8fff-dd92ffff0000" - } - ], - "parameters": [ - { - "name": "Temperature", - "guid": "00000001-000a-4fff-8fff-0000ffff0000" - } - ], - "units": [ - { - "equation": "(5/9)*[K]", - "name": "Temperature (Rankine/Fahrenheit)", - "symbol": "°R", - "relativeSymbol": "°F", - "guid": "00000003-0013-4fff-8fff-0000ffff0000" - } - ] - } - } } } } @@ -73941,145 +51412,6 @@ } } }, - "/v1alpha/databases/{database-key}/units:validate-equation": { - "post": { - "tags": [ - "Schema - Units" - ], - "summary": "Check whether the unit equation is valid.", - "operationId": "ValidateUnitEquation", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaValidateUnitEquationResponse" - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Database not found" - } - } - } - }, - "/v1alpha/databases/{database-key}/units-grouped-by-compatibility": { - "get": { - "tags": [ - "Schema - Units" - ], - "summary": "Get units grouped by compatibility, each grouping contains only compatible units", - "operationId": "GetUnitsGroupedByCompatibility", - "parameters": [ - { - "name": "database-key", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaUnitsGroupingInfo" - }, - "examples": { - "Example 1": { - "summary": "Units grouped by compatibilty", - "description": "Example of units grouped by compatibility", - "value": { - "unitGroups": [ - [ - { - "symbol": "in", - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "cm", - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "m", - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - ], - [ - { - "symbol": "Pa", - "guid": "00000025-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "MPa", - "guid": "0000002b-0013-4fff-8fff-0000ffff0000" - }, - { - "symbol": "bar", - "guid": "000000de-0013-4fff-8fff-0000ffff0000" - } - ] - ] - } - } - } - } - } - }, - "404": { - "description": "Database not found" - } - } - } - }, "/v1alpha/databases/{database-key}/unit-systems": { "get": { "tags": [ @@ -74091,12 +51423,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -74126,12 +51455,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } } ], @@ -74144,42 +51470,10 @@ "examples": { "Example 1": { "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { "name": "Hawaiian common", - "guid": "339511b8-77d8-4703-acbd-85be189857f2" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" + "guid": "2ccd7dfe-d69b-4eed-98c1-52ed448fefe3" } } } @@ -74191,42 +51485,10 @@ "examples": { "Example 1": { "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { "name": "Hawaiian common", - "guid": "339511b8-77d8-4703-acbd-85be189857f2" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" + "guid": "2ccd7dfe-d69b-4eed-98c1-52ed448fefe3" } } } @@ -74238,42 +51500,10 @@ "examples": { "Example 1": { "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { "name": "Hawaiian common", - "guid": "339511b8-77d8-4703-acbd-85be189857f2" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" + "guid": "2ccd7dfe-d69b-4eed-98c1-52ed448fefe3" } } } @@ -74285,42 +51515,10 @@ "examples": { "Example 1": { "summary": "Unit System", - "description": "This example demonstrates how to create a new unit system. Unit mappings will default to each unit being mapped to itself.", - "value": { - "name": "Hawaiian common" - } - }, - "Example 2": { - "summary": "Unit System with guid", - "description": "This example demonstrates how to create a new unit system with a specified guid value. Unit mappings will default to each unit being mapped to itself.", + "description": "This example demonstrates how to create a new unit system for the MI_Training database. Only guid and name can be set as the rest of fields is backend generated and changes via equivalents endpoints.", "value": { "name": "Hawaiian common", - "guid": "339511b8-77d8-4703-acbd-85be189857f2" - } - }, - "Example 3": { - "summary": "Unit System with unit mappings", - "description": "This example demonstrates how to create a new unit system with specified unit mappings. Unit mappings not specified will default to each unit being mapped to itself.", - "value": { - "unitMappings": [ - { - "unit": { - "guid": "00000011-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - }, - { - "unit": { - "guid": "00000099-0013-4fff-8fff-0000ffff0000" - }, - "equivalentUnit": { - "guid": "00000098-0013-4fff-8fff-0000ffff0000" - } - } - ], - "name": "Hawaiian common" + "guid": "2ccd7dfe-d69b-4eed-98c1-52ed448fefe3" } } } @@ -74361,12 +51559,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -74405,12 +51600,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -74435,7 +51627,7 @@ "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { "name": "UK Imperial (Updated)", - "guid": "24228507-90df-4323-9aef-ef4445713838" + "guid": "287a97a1-ec80-4a5c-a113-83535c79d526" } }, "Example 2": { @@ -74449,7 +51641,7 @@ "summary": "Update guid", "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "434b183c-0532-4c2b-b2d3-17cb825ef634" + "guid": "82d4f235-d2d5-4ceb-a229-c5761902d789" } } } @@ -74464,7 +51656,7 @@ "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { "name": "UK Imperial (Updated)", - "guid": "24228507-90df-4323-9aef-ef4445713838" + "guid": "287a97a1-ec80-4a5c-a113-83535c79d526" } }, "Example 2": { @@ -74478,7 +51670,7 @@ "summary": "Update guid", "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "434b183c-0532-4c2b-b2d3-17cb825ef634" + "guid": "82d4f235-d2d5-4ceb-a229-c5761902d789" } } } @@ -74493,7 +51685,7 @@ "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { "name": "UK Imperial (Updated)", - "guid": "24228507-90df-4323-9aef-ef4445713838" + "guid": "287a97a1-ec80-4a5c-a113-83535c79d526" } }, "Example 2": { @@ -74507,7 +51699,7 @@ "summary": "Update guid", "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "434b183c-0532-4c2b-b2d3-17cb825ef634" + "guid": "82d4f235-d2d5-4ceb-a229-c5761902d789" } } } @@ -74522,7 +51714,7 @@ "description": "This example demonstrates how to update all properties of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { "name": "UK Imperial (Updated)", - "guid": "24228507-90df-4323-9aef-ef4445713838" + "guid": "287a97a1-ec80-4a5c-a113-83535c79d526" } }, "Example 2": { @@ -74536,7 +51728,7 @@ "summary": "Update guid", "description": "This example demonstrates how to update the 'Guid' of the 'UK Imperial' unit system (guid = 00000007-0014-4fff-8fff-0000ffff0000) from the MI_Training database.", "value": { - "guid": "434b183c-0532-4c2b-b2d3-17cb825ef634" + "guid": "82d4f235-d2d5-4ceb-a229-c5761902d789" } } } @@ -74575,12 +51767,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -74609,177 +51798,6 @@ } } }, - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates/{templateGuid}": { - "get": { - "tags": [ - "Schema - XY Chart Templates" - ], - "summary": "Get XY chart template in database.", - "operationId": "GetTemplate", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "tableGuid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "templateGuid", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaXYChartTemplate" - } - } - } - }, - "404": { - "description": "Database, table or chart template not found" - } - } - } - }, - "/v1alpha/databases/{databaseKey}/tables/{tableGuid}/xyChartTemplates": { - "get": { - "tags": [ - "Schema - XY Chart Templates" - ], - "summary": "Get XY chart templates in database", - "operationId": "GetTemplates", - "parameters": [ - { - "name": "databaseKey", - "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" - } - }, - { - "name": "tableGuid", - "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "required": true, - "schema": { - "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", - "format": "uuid" - } - }, - { - "name": "mode", - "in": "query", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the header.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "X-Ansys-VC-Mode", - "in": "header", - "description": "The version control mode. If not provided, defaults to write mode if the user is allowed to see that. Can also be set in the query string.", - "schema": { - "enum": [ - "read", - "write" - ], - "type": "string" - } - }, - { - "name": "pageSize", - "in": "query", - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Ok", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GsaXYChartTemplatesInfo" - } - } - } - }, - "404": { - "description": "Database or table not found" - } - } - } - }, "/v1alpha/databases/{database-key}/tables/{table-identity}:search": { "post": { "tags": [ @@ -74791,12 +51809,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -74859,8 +51874,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -74889,8 +51903,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -74912,8 +51925,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -74930,8 +51942,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -74956,8 +51967,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -74973,8 +51983,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -75023,8 +52032,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -75041,8 +52049,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -75088,8 +52095,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -75143,8 +52149,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -75173,8 +52178,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -75183,13 +52187,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "06416432-ebf0-4740-839c-a5216eac1240", - "fce1f4cc-5dea-4c42-85bd-b80f5ddb3fac" + "aa0b99a8-3989-4d90-bd57-18c9af2cc78c", + "5529fed1-c93d-4478-b097-6742b46818f0" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -75201,8 +52204,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -75214,8 +52216,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -75227,8 +52228,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -75239,8 +52239,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -75251,8 +52250,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -75274,8 +52272,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -75304,8 +52301,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -75349,8 +52345,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -75400,8 +52395,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -75428,8 +52422,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -75460,8 +52453,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -75482,8 +52474,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -75514,8 +52505,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -75546,8 +52536,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -75574,8 +52563,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -75599,8 +52587,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -75628,8 +52615,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -75660,8 +52646,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -75690,8 +52675,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -75720,8 +52704,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -75743,8 +52726,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -75761,8 +52743,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -75787,8 +52768,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -75804,8 +52784,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -75854,8 +52833,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -75872,8 +52850,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -75919,8 +52896,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -75974,8 +52950,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -76004,8 +52979,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -76014,13 +52988,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "06416432-ebf0-4740-839c-a5216eac1240", - "fce1f4cc-5dea-4c42-85bd-b80f5ddb3fac" + "aa0b99a8-3989-4d90-bd57-18c9af2cc78c", + "5529fed1-c93d-4478-b097-6742b46818f0" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -76032,8 +53005,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -76045,8 +53017,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -76058,8 +53029,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -76070,8 +53040,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -76082,8 +53051,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -76105,8 +53073,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -76135,8 +53102,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -76180,8 +53146,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -76231,8 +53196,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -76259,8 +53223,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -76291,8 +53254,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -76313,8 +53275,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -76345,8 +53306,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -76377,8 +53337,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -76405,8 +53364,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -76430,8 +53388,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -76459,8 +53416,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -76491,8 +53447,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -76521,8 +53476,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -76551,8 +53505,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -76574,8 +53527,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -76592,8 +53544,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -76618,8 +53569,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -76635,8 +53585,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -76685,8 +53634,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -76703,8 +53651,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -76750,8 +53697,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -76805,8 +53751,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -76835,8 +53780,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -76845,13 +53789,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "06416432-ebf0-4740-839c-a5216eac1240", - "fce1f4cc-5dea-4c42-85bd-b80f5ddb3fac" + "aa0b99a8-3989-4d90-bd57-18c9af2cc78c", + "5529fed1-c93d-4478-b097-6742b46818f0" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -76863,8 +53806,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -76876,8 +53818,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -76889,8 +53830,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -76901,8 +53841,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -76913,8 +53852,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -76936,8 +53874,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -76966,8 +53903,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -77011,8 +53947,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -77062,8 +53997,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -77090,8 +54024,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -77122,8 +54055,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -77144,8 +54076,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -77176,8 +54107,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -77208,8 +54138,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -77236,8 +54165,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -77261,8 +54189,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -77290,8 +54217,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -77322,8 +54248,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -77352,8 +54277,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -77382,8 +54306,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -77405,8 +54328,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -77423,8 +54345,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -77449,8 +54370,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -77466,8 +54386,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -77516,8 +54435,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -77534,8 +54452,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -77581,8 +54498,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -77636,8 +54552,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -77666,8 +54581,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -77676,13 +54590,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "06416432-ebf0-4740-839c-a5216eac1240", - "fce1f4cc-5dea-4c42-85bd-b80f5ddb3fac" + "aa0b99a8-3989-4d90-bd57-18c9af2cc78c", + "5529fed1-c93d-4478-b097-6742b46818f0" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -77694,8 +54607,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -77707,8 +54619,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -77720,8 +54631,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -77732,8 +54642,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -77744,8 +54653,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -77767,8 +54675,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -77797,8 +54704,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -77842,8 +54748,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -77893,8 +54798,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -77921,8 +54825,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -77953,8 +54856,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -77975,8 +54877,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -78007,8 +54908,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -78039,8 +54939,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -78067,8 +54966,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -78092,8 +54990,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -78121,8 +55018,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -78153,8 +55049,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -78196,22 +55091,17 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { "name": "table-guid", "in": "path", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Tables/GetTables](#/Schema%20-%20Tables/GetTables) or [Schema - Tables/QueryTables](#/Schema%20-%20Tables/QueryTables)", "format": "uuid" } }, @@ -78266,8 +55156,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 32": { @@ -78296,8 +55185,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 33": { @@ -78319,8 +55207,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 34": { @@ -78337,8 +55224,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 35": { @@ -78363,8 +55249,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 36": { @@ -78380,8 +55265,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 37": { @@ -78430,8 +55314,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 38": { @@ -78448,8 +55331,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 39": { @@ -78495,8 +55377,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 40": { @@ -78550,8 +55431,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 41": { @@ -78580,8 +55460,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 42": { @@ -78590,13 +55469,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "65f4803a-4d2d-447f-8ef8-f4216300b975", - "c55796a2-7cf3-4c95-b67a-9312b7420165" + "3c005563-232f-4aa5-ac39-11485408a686", + "b353ecf0-f398-4098-971f-ef85d4866e50" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 43": { @@ -78608,8 +55486,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 44": { @@ -78621,8 +55498,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 45": { @@ -78634,8 +55510,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 46": { @@ -78646,8 +55521,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 47": { @@ -78658,8 +55532,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 48": { @@ -78681,8 +55554,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 49": { @@ -78711,8 +55583,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 50": { @@ -78756,8 +55627,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 51": { @@ -78807,8 +55677,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 52": { @@ -78835,8 +55704,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 53": { @@ -78867,8 +55735,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 54": { @@ -78889,8 +55756,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 55": { @@ -78921,8 +55787,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 56": { @@ -78953,8 +55818,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 57": { @@ -78981,8 +55845,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 58": { @@ -79006,8 +55869,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 59": { @@ -79035,8 +55897,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 60": { @@ -79067,8 +55928,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -79097,8 +55957,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 32": { @@ -79127,8 +55986,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 33": { @@ -79150,8 +56008,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 34": { @@ -79168,8 +56025,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 35": { @@ -79194,8 +56050,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 36": { @@ -79211,8 +56066,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 37": { @@ -79261,8 +56115,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 38": { @@ -79279,8 +56132,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 39": { @@ -79326,8 +56178,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 40": { @@ -79381,8 +56232,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 41": { @@ -79411,8 +56261,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 42": { @@ -79421,13 +56270,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "65f4803a-4d2d-447f-8ef8-f4216300b975", - "c55796a2-7cf3-4c95-b67a-9312b7420165" + "3c005563-232f-4aa5-ac39-11485408a686", + "b353ecf0-f398-4098-971f-ef85d4866e50" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 43": { @@ -79439,8 +56287,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 44": { @@ -79452,8 +56299,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 45": { @@ -79465,8 +56311,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 46": { @@ -79477,8 +56322,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 47": { @@ -79489,8 +56333,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 48": { @@ -79512,8 +56355,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 49": { @@ -79542,8 +56384,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 50": { @@ -79587,8 +56428,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 51": { @@ -79638,8 +56478,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 52": { @@ -79666,8 +56505,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 53": { @@ -79698,8 +56536,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 54": { @@ -79720,8 +56557,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 55": { @@ -79752,8 +56588,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 56": { @@ -79784,8 +56619,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 57": { @@ -79812,8 +56646,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 58": { @@ -79837,8 +56670,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 59": { @@ -79866,8 +56698,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 60": { @@ -79898,8 +56729,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -79928,8 +56758,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 32": { @@ -79958,8 +56787,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 33": { @@ -79981,8 +56809,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 34": { @@ -79999,8 +56826,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 35": { @@ -80025,8 +56851,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 36": { @@ -80042,8 +56867,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 37": { @@ -80092,8 +56916,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 38": { @@ -80110,8 +56933,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 39": { @@ -80157,8 +56979,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 40": { @@ -80212,8 +57033,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 41": { @@ -80242,8 +57062,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 42": { @@ -80252,13 +57071,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "65f4803a-4d2d-447f-8ef8-f4216300b975", - "c55796a2-7cf3-4c95-b67a-9312b7420165" + "3c005563-232f-4aa5-ac39-11485408a686", + "b353ecf0-f398-4098-971f-ef85d4866e50" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 43": { @@ -80270,8 +57088,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 44": { @@ -80283,8 +57100,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 45": { @@ -80296,8 +57112,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 46": { @@ -80308,8 +57123,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 47": { @@ -80320,8 +57134,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 48": { @@ -80343,8 +57156,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 49": { @@ -80373,8 +57185,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 50": { @@ -80418,8 +57229,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 51": { @@ -80469,8 +57279,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 52": { @@ -80497,8 +57306,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 53": { @@ -80529,8 +57337,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 54": { @@ -80551,8 +57358,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 55": { @@ -80583,8 +57389,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 56": { @@ -80615,8 +57420,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 57": { @@ -80643,8 +57447,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 58": { @@ -80668,8 +57471,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 59": { @@ -80697,8 +57499,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 60": { @@ -80729,8 +57530,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -80759,8 +57559,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 32": { @@ -80789,8 +57588,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 33": { @@ -80812,8 +57610,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 34": { @@ -80830,8 +57627,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 35": { @@ -80856,8 +57652,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 36": { @@ -80873,8 +57668,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 37": { @@ -80923,8 +57717,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 38": { @@ -80941,8 +57734,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 39": { @@ -80988,8 +57780,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 40": { @@ -81043,8 +57834,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 41": { @@ -81073,8 +57863,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 42": { @@ -81083,13 +57872,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "65f4803a-4d2d-447f-8ef8-f4216300b975", - "c55796a2-7cf3-4c95-b67a-9312b7420165" + "3c005563-232f-4aa5-ac39-11485408a686", + "b353ecf0-f398-4098-971f-ef85d4866e50" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 43": { @@ -81101,8 +57889,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 44": { @@ -81114,8 +57901,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 45": { @@ -81127,8 +57913,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 46": { @@ -81139,8 +57924,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 47": { @@ -81151,8 +57935,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 48": { @@ -81174,8 +57957,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 49": { @@ -81204,8 +57986,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 50": { @@ -81249,8 +58030,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 51": { @@ -81300,8 +58080,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 52": { @@ -81328,8 +58107,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 53": { @@ -81360,8 +58138,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 54": { @@ -81382,8 +58159,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 55": { @@ -81414,8 +58190,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 56": { @@ -81446,8 +58221,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 57": { @@ -81474,8 +58248,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 58": { @@ -81499,8 +58272,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 59": { @@ -81528,8 +58300,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 60": { @@ -81560,8 +58331,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -81603,12 +58373,9 @@ { "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } }, { @@ -81662,8 +58429,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -81692,8 +58458,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -81715,8 +58480,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -81733,8 +58497,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -81759,8 +58522,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -81776,8 +58538,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -81826,8 +58587,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -81844,8 +58604,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -81891,8 +58650,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -81946,8 +58704,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -81976,8 +58733,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -81986,13 +58742,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "141bff61-2ef6-4abe-97c1-00c9948227fc", - "61a08c3d-8bf9-4157-8017-b8e4d0204c47" + "ae32d753-a981-4500-9736-233aa05a3fc1", + "5278cda4-a089-45c8-bb24-b4c007b5d163" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -82004,8 +58759,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -82017,8 +58771,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -82030,8 +58783,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -82042,8 +58794,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -82054,8 +58805,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -82077,8 +58827,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -82107,8 +58856,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -82152,8 +58900,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -82203,8 +58950,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -82231,8 +58977,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -82263,8 +59008,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -82285,8 +59029,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -82317,8 +59060,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -82349,8 +59091,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -82377,8 +59118,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -82402,8 +59142,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -82431,8 +59170,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -82463,8 +59201,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 31": { @@ -82501,8 +59238,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 32": { @@ -82551,8 +59287,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -82581,8 +59316,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -82611,8 +59345,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -82634,8 +59367,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -82652,8 +59384,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -82678,8 +59409,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -82695,8 +59425,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -82745,8 +59474,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -82763,8 +59491,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -82810,8 +59537,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -82865,8 +59591,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -82895,8 +59620,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -82905,13 +59629,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "141bff61-2ef6-4abe-97c1-00c9948227fc", - "61a08c3d-8bf9-4157-8017-b8e4d0204c47" + "ae32d753-a981-4500-9736-233aa05a3fc1", + "5278cda4-a089-45c8-bb24-b4c007b5d163" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -82923,8 +59646,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -82936,8 +59658,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -82949,8 +59670,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -82961,8 +59681,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -82973,8 +59692,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -82996,8 +59714,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -83026,8 +59743,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -83071,8 +59787,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -83122,8 +59837,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -83150,8 +59864,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -83182,8 +59895,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -83204,8 +59916,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -83236,8 +59947,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -83268,8 +59978,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -83296,8 +60005,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -83321,8 +60029,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -83350,8 +60057,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -83382,8 +60088,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 31": { @@ -83420,8 +60125,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 32": { @@ -83470,8 +60174,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -83500,8 +60203,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -83530,8 +60232,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -83553,8 +60254,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -83571,8 +60271,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -83597,8 +60296,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -83614,8 +60312,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -83664,8 +60361,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -83682,8 +60378,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -83729,8 +60424,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -83784,8 +60478,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -83814,8 +60507,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -83824,13 +60516,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "141bff61-2ef6-4abe-97c1-00c9948227fc", - "61a08c3d-8bf9-4157-8017-b8e4d0204c47" + "ae32d753-a981-4500-9736-233aa05a3fc1", + "5278cda4-a089-45c8-bb24-b4c007b5d163" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -83842,8 +60533,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -83855,8 +60545,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -83868,8 +60557,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -83880,8 +60568,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -83892,8 +60579,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -83915,8 +60601,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -83945,8 +60630,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -83990,8 +60674,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -84041,8 +60724,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -84069,8 +60751,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -84101,8 +60782,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -84123,8 +60803,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -84155,8 +60834,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -84187,8 +60865,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -84215,8 +60892,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -84240,8 +60916,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -84269,8 +60944,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -84301,8 +60975,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 31": { @@ -84339,8 +61012,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 32": { @@ -84389,8 +61061,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -84419,8 +61090,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -84449,8 +61119,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -84472,8 +61141,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -84490,8 +61158,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -84516,8 +61183,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -84533,8 +61199,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -84583,8 +61248,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -84601,8 +61265,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -84648,8 +61311,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -84703,8 +61365,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -84733,8 +61394,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -84743,13 +61403,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "141bff61-2ef6-4abe-97c1-00c9948227fc", - "61a08c3d-8bf9-4157-8017-b8e4d0204c47" + "ae32d753-a981-4500-9736-233aa05a3fc1", + "5278cda4-a089-45c8-bb24-b4c007b5d163" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -84761,8 +61420,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -84774,8 +61432,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -84787,8 +61444,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -84799,8 +61455,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -84811,8 +61466,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -84834,8 +61488,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -84864,8 +61517,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -84909,8 +61561,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -84960,8 +61611,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -84988,8 +61638,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -85020,8 +61669,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -85042,8 +61690,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -85074,8 +61721,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -85106,8 +61752,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -85134,8 +61779,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -85159,8 +61803,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -85188,8 +61831,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -85220,8 +61862,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 31": { @@ -85258,8 +61899,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 32": { @@ -85308,8 +61948,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -85383,8 +62022,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -85413,8 +62051,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -85436,8 +62073,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -85454,8 +62090,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -85480,8 +62115,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -85497,8 +62131,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -85547,8 +62180,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -85565,8 +62197,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -85612,8 +62243,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -85667,8 +62297,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -85697,8 +62326,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -85707,13 +62335,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "1d84a53c-ef00-4345-ba93-9b196c42707c", - "6dfd95c0-1b5c-4aaf-bfb6-fe54c4d63bdf" + "1494c5b0-f60a-49b4-a7b3-0875240a7bad", + "b49de624-89c0-45ae-8cd9-0e3d089ec8d1" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -85725,8 +62352,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -85738,8 +62364,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -85751,8 +62376,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -85763,8 +62387,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -85775,8 +62398,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -85798,8 +62420,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -85828,8 +62449,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -85873,8 +62493,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -85924,8 +62543,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -85952,8 +62570,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -85984,8 +62601,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -86006,8 +62622,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -86038,8 +62653,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -86070,8 +62684,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -86098,8 +62711,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -86123,8 +62735,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -86152,8 +62763,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -86184,8 +62794,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -86214,8 +62823,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -86244,8 +62852,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -86267,8 +62874,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -86285,8 +62891,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -86311,8 +62916,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -86328,8 +62932,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -86378,8 +62981,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -86396,8 +62998,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -86443,8 +63044,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -86498,8 +63098,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -86528,8 +63127,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -86538,13 +63136,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "1d84a53c-ef00-4345-ba93-9b196c42707c", - "6dfd95c0-1b5c-4aaf-bfb6-fe54c4d63bdf" + "1494c5b0-f60a-49b4-a7b3-0875240a7bad", + "b49de624-89c0-45ae-8cd9-0e3d089ec8d1" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -86556,8 +63153,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -86569,8 +63165,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -86582,8 +63177,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -86594,8 +63188,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -86606,8 +63199,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -86629,8 +63221,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -86659,8 +63250,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -86704,8 +63294,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -86755,8 +63344,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -86783,8 +63371,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -86815,8 +63402,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -86837,8 +63423,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -86869,8 +63454,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -86901,8 +63485,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -86929,8 +63512,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -86954,8 +63536,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -86983,8 +63564,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -87015,8 +63595,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -87045,8 +63624,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -87075,8 +63653,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -87098,8 +63675,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -87116,8 +63692,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -87142,8 +63717,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -87159,8 +63733,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -87209,8 +63782,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -87227,8 +63799,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -87274,8 +63845,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -87329,8 +63899,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -87359,8 +63928,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -87369,13 +63937,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "1d84a53c-ef00-4345-ba93-9b196c42707c", - "6dfd95c0-1b5c-4aaf-bfb6-fe54c4d63bdf" + "1494c5b0-f60a-49b4-a7b3-0875240a7bad", + "b49de624-89c0-45ae-8cd9-0e3d089ec8d1" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -87387,8 +63954,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -87400,8 +63966,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -87413,8 +63978,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -87425,8 +63989,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -87437,8 +64000,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -87460,8 +64022,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -87490,8 +64051,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -87535,8 +64095,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -87586,8 +64145,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -87614,8 +64172,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -87646,8 +64203,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -87668,8 +64224,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -87700,8 +64255,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -87732,8 +64286,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -87760,8 +64313,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -87785,8 +64337,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -87814,8 +64365,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -87846,8 +64396,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -87876,8 +64425,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 2": { @@ -87906,8 +64454,7 @@ ], "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 3": { @@ -87929,8 +64476,7 @@ }, "type": "text" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 4": { @@ -87947,8 +64493,7 @@ }, "type": "textPrefix" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 5": { @@ -87973,8 +64518,7 @@ "sortDirection": "ascending", "type": "attribute" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 6": { @@ -87990,8 +64534,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 7": { @@ -88040,8 +64583,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 8": { @@ -88058,8 +64600,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 9": { @@ -88105,8 +64646,7 @@ "none": [], "type": "boolean" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 10": { @@ -88160,8 +64700,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 11": { @@ -88190,8 +64729,7 @@ "sortDirection": "descending", "type": "recordProperty" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 12": { @@ -88200,13 +64738,12 @@ "value": { "criterion": { "recordListIdentifiers": [ - "1d84a53c-ef00-4345-ba93-9b196c42707c", - "6dfd95c0-1b5c-4aaf-bfb6-fe54c4d63bdf" + "1494c5b0-f60a-49b4-a7b3-0875240a7bad", + "b49de624-89c0-45ae-8cd9-0e3d089ec8d1" ], "type": "recordListMember" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 13": { @@ -88218,8 +64755,7 @@ "recordHistoryGuid": "dc1c65fc-25fa-4b86-9b5b-d3f25fa2a8ae", "type": "reference" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 14": { @@ -88231,8 +64767,7 @@ "directParentOnly": false, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 15": { @@ -88244,8 +64779,7 @@ "directParentOnly": false, "type": "recordAncestorHistory" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 16": { @@ -88256,8 +64790,7 @@ "directParentOnly": true, "type": "recordAncestor" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 17": { @@ -88268,8 +64801,7 @@ "subsetGuid": "00000b36-0010-4fff-8fff-dd92ffff0000", "type": "subset" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 18": { @@ -88291,8 +64823,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 19": { @@ -88321,8 +64852,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 20": { @@ -88366,8 +64896,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 21": { @@ -88417,8 +64946,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 22": { @@ -88445,8 +64973,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 23": { @@ -88477,8 +65004,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 24": { @@ -88499,8 +65025,7 @@ "attributeCriterionType": "exists", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 25": { @@ -88531,8 +65056,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 26": { @@ -88563,8 +65087,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 27": { @@ -88591,8 +65114,7 @@ "pageSize": 5, "keepAliveInMinutes": 10, "pageNumber": 1 - }, - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + } } }, "Example 28": { @@ -88616,8 +65138,7 @@ "sortDirection": "ascending", "type": "relevance" } - ], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + ] } }, "Example 29": { @@ -88645,8 +65166,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } }, "Example 30": { @@ -88677,8 +65197,7 @@ "attributeCriterionType": "matches", "type": "attribute" }, - "sortCriteria": [], - "tableSearchBehaviour": "OnlyIncludeRecordsFromSearchableTables" + "sortCriteria": [] } } } @@ -88818,36 +65337,22 @@ } } }, - "/v1alpha/status": { - "get": { - "tags": [ - "Status" - ], - "summary": "Check whether the API is available", - "operationId": "Get", - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/v1alpha/status/databases": { + "/v1alpha/selection-searches": { "get": { "tags": [ - "Status" + "SelectionSearches" ], - "summary": "Returns status information for all databases", - "operationId": "GetStatus", + "summary": "Returns all searches visible to the calling user.", + "operationId": "GetAll", "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } } }, @@ -88855,7 +65360,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } } }, @@ -88863,175 +65368,461 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } } } } + }, + "403": { + "description": "Forbidden" + } + } + }, + "post": { + "tags": [ + "SelectionSearches" + ], + "summary": "Creates a new search with the specified properties.", + "operationId": "CreateSearch", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaCreateSearchRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" } } } }, - "/v1alpha/status/databases/{database-key}": { + "/v1alpha/selection-searches/search": { + "post": { + "tags": [ + "SelectionSearches" + ], + "summary": "Retrieves a collection of searches that match the specified criteria.", + "operationId": "Search", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaFindSearchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Ok", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSelectionSearch" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/v1alpha/selection-searches/search/{searchIdentifier}": { "get": { "tags": [ - "Status" + "SelectionSearches" ], - "summary": "Returns status information for a given database", - "operationId": "GetDatabaseStatus", + "summary": "Returns the given search if it exists and the calling user has access to it", + "operationId": "GetSearch", "parameters": [ { - "name": "database-key", + "name": "searchIdentifier", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "format": "uuid" } } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + "$ref": "#/components/schemas/GsaSelectionSearch" } } } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search result not found" + }, + "410": { + "description": "Search result no longer available" + } + } + }, + "put": { + "tags": [ + "SelectionSearches" + ], + "summary": "If the search exists, updates the properties of the search. This will overwrite all current properties.\r\nIf the search does not exist or the calling user does not have access to it, returns '404 not found' response.", + "operationId": "SaveSearch", + "parameters": [ + { + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSaveSearchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Search not found" + } + } + }, + "delete": { + "tags": [ + "SelectionSearches" + ], + "summary": "Delete an existing selection search.", + "operationId": "DeleteSearch", + "parameters": [ + { + "name": "searchIdentifier", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Selection search not found" } } } }, - "/v1alpha/status/search-cluster": { + "/v1alpha/serverManager/email": { "get": { "tags": [ - "Status" + "Server Manager" ], - "summary": "Returns disk status information for the search cluster", - "operationId": "GetSearchClusterStatus", + "operationId": "GetSmtpProperties", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" + "$ref": "#/components/schemas/GsaSmtpProperties" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" + "$ref": "#/components/schemas/GsaSmtpProperties" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchClusterStatus" + "$ref": "#/components/schemas/GsaSmtpProperties" } } } } } + }, + "put": { + "tags": [ + "Server Manager" + ], + "operationId": "Put", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GsaSmtpProperties" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } } }, - "/v1alpha/status/searchServiceStatus": { + "/v1alpha/status": { "get": { "tags": [ "Status" ], - "summary": "Returns information about the Search Service status", - "operationId": "GetSearchServiceStatusAsync", + "summary": "Check whether the API is available", + "operationId": "Get", "responses": { "200": { - "description": "Ok", + "description": "OK" + } + } + } + }, + "/v1alpha/status/databases": { + "get": { + "tags": [ + "Status" + ], + "summary": "Returns status information for all databases", + "operationId": "GetStatus", + "responses": { + "200": { + "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchServiceStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } } } } - }, - "403": { - "description": "Forbidden" } } } }, - "/v1alpha/status/databases/{databaseKey}/searchIndexStatus": { + "/v1alpha/status/databases/{database-key}": { "get": { "tags": [ "Status" ], - "summary": "Returns information about the Search Index status", - "operationId": "GetSearchIndexStatusAsync", + "summary": "Returns status information for a given database", + "operationId": "GetDatabaseStatus", "parameters": [ { - "name": "databaseKey", + "name": "database-key", "in": "path", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", "required": true, "schema": { - "type": "string", - "description": "See [Schema - Databases/GetAllDatabases](#/Schema%20-%20Databases/GetAllDatabases)", - "example": "MI_TRAINING" + "type": "string" } - }, - { - "name": "includeErrorDetails", - "in": "query", - "schema": { - "type": "boolean", - "default": true + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GsaDatabaseStatusInformation" + } + } } } + } + } + }, + "/v1alpha/status/search-cluster": { + "get": { + "tags": [ + "Status" ], + "summary": "Returns disk status information for the search cluster", + "operationId": "GetSearchClusterStatus", "responses": { "200": { - "description": "Ok", + "description": "OK", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" + "$ref": "#/components/schemas/GsaSearchClusterStatus" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" + "$ref": "#/components/schemas/GsaSearchClusterStatus" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GsaSearchIndexStatus" + "$ref": "#/components/schemas/GsaSearchClusterStatus" } } } - }, - "403": { - "description": "Forbidden" } } } @@ -89091,28 +65882,6 @@ "description": "Values that can be used in place of an attribute identity to perform a search, aggregation or export of a record property. RecordCreatedBy and RecordModifiedBy cannot be used in free text search or aggregation.", "format": "int32" }, - "GrantaMISearchFreeTextIdentifiers": { - "type": "object", - "properties": { - "attributeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "columnGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaAboutAttributeCannotBeMetaAttributeErrorDetail": { "type": "object", "allOf": [ @@ -89124,448 +65893,22 @@ } ], "additionalProperties": false, - "description": "Cannot have a meta-attribute as an 'About attribute'.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'aboutAttributeCannotBeMeta'", + "description": "Cannot have a meta-attribute as an 'About attribute'.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'aboutAttributeCannotBeMeta'", "x-discriminator-value": "aboutAttributeCannotBeMeta", "x-discriminator-name": "reason" }, - "GsaAccessControlCategoriesInfo": { - "required": [ - "categories" - ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategory" - } - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategory": { - "required": [ - "discreteType", - "guid", - "name" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryTableMapping" - }, - "description": "Information specific to each table.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchEntityAccessControlCategoryErrorDetail](#model-GsaNoSuchEntityAccessControlCategoryErrorDetail)\r\n * [GsaDiscreteValueNotInDiscreteTypeErrorDetail](#model-GsaDiscreteValueNotInDiscreteTypeErrorDetail)\r\n * [GsaAttributeNotOnTableErrorDetail](#model-GsaAttributeNotOnTableErrorDetail)\r\n * [GsaAttributeDiscreteTypeMismatchErrorDetail](#model-GsaAttributeDiscreteTypeMismatchErrorDetail)\r\n * [GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail](#model-GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail)\r\n * [GsaNamedEntityAccessControlCategoryErrorDetail](#model-GsaNamedEntityAccessControlCategoryErrorDetail)\r\n * [GsaDuplicateTableErrorDetail](#model-GsaDuplicateTableErrorDetail)\r\n * [GsaDuplicateDiscreteValueErrorDetail](#model-GsaDuplicateDiscreteValueErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchEntity": "#/components/schemas/GsaNoSuchEntityAccessControlCategoryErrorDetail", - "discreteValueNotInDiscreteType": "#/components/schemas/GsaDiscreteValueNotInDiscreteTypeErrorDetail", - "attributeNotOnTable": "#/components/schemas/GsaAttributeNotOnTableErrorDetail", - "attributeDiscreteTypeMismatch": "#/components/schemas/GsaAttributeDiscreteTypeMismatchErrorDetail", - "multipleDefaultValuesInSingleValuedDiscrete": "#/components/schemas/GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityAccessControlCategoryErrorDetail", - "duplicateTable": "#/components/schemas/GsaDuplicateTableErrorDetail", - "duplicateDiscreteValue": "#/components/schemas/GsaDuplicateDiscreteValueErrorDetail" - } - } - }, - "GsaAccessControlCategoryErrorReason": { - "enum": [ - "noSuchEntity", - "discreteValueNotInDiscreteType", - "attributeNotOnTable", - "attributeDiscreteTypeMismatch", - "multipleDefaultValuesInSingleValuedDiscrete", - "namedEntity", - "duplicateTable", - "duplicateDiscreteValue" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchEntity: An entity (table, attribute, discrete type, or discrete value) could not be found.
    • \r\n
  • discreteValueNotInDiscreteType: A discrete value does not belong to the specified discrete type.
    • \r\n
  • attributeNotOnTable: The attribute does not belong to the specified table.
    • \r\n
  • attributeDiscreteTypeMismatch: The attribute does not use the correct discrete type.
    • \r\n
  • multipleDefaultValuesInSingleValuedDiscrete: Multiple default values were specified for a single-valued discrete attribute.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • duplicateTable: A table GUID has been specified more than once.
    • \r\n
  • duplicateDiscreteValue: A discrete value GUID has been specified more than once.
    • \r\n
\r\n" - }, - "GsaAccessControlCategoryInclude": { - "enum": [ - "tableMappings" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • tableMappings: Include tableMappings in the response.
    • \r\n
\r\n" - }, - "GsaAccessControlCategoryNoSuchEntityType": { - "enum": [ - "table", - "attribute", - "discreteType", - "discreteValue" - ], - "type": "string" - }, - "GsaAccessControlCategoryTableMapping": { - "required": [ - "attribute", - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "description": "The values applied to the table for this category.", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlCategoryUpdateException": { - "required": [ - "categoryGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "categoryGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaAccessControlInfo": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaPermissionBasedAccessControlInfo](#model-GsaPermissionBasedAccessControlInfo)\r\n * [GsaAttributeBasedAccessControlInfo](#model-GsaAttributeBasedAccessControlInfo)", - "discriminator": { - "propertyName": "mode", - "mapping": { - "permissionBased": "#/components/schemas/GsaPermissionBasedAccessControlInfo", - "attributeBased": "#/components/schemas/GsaAttributeBasedAccessControlInfo" - } - } - }, - "GsaAccessControlMode": { - "enum": [ - "permissionBased", - "attributeBased" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • permissionBased: Permission-based access control.
    • \r\n
  • attributeBased: Attribute-based access control.
    • \r\n
\r\n" - }, - "GsaAccessControlModeInfo": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - } - }, - "additionalProperties": false - }, - "GsaActivityLogApplicationNameFilter": { - "required": [ - "applicationNameToMatch" - ], - "type": "object", - "properties": { - "applicationNameToMatch": { - "type": "string" - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the application name should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, - "GsaActivityLogApplicationNamesCollectionFilter": { - "required": [ - "applicationNamesToMatch" - ], - "type": "object", - "properties": { - "applicationNamesToMatch": { - "type": "array", - "items": { - "type": "string" - } - }, - "collectionMatchType": { - "$ref": "#/components/schemas/GsaActivityLogCollectionMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\ncollectionMatchType: Defines how the application names collection should be matched. If not specified, defaults to collectionExactMatch." - }, - "GsaActivityLogCollectionMatchType": { - "enum": [ - "collectionExactMatch", - "collectionContains" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • collectionExactMatch: Collection matches exactly.
    • \r\n
  • collectionContains: The collection contains this subset.
    • \r\n
\r\n" - }, - "GsaActivityLogDatabaseKeyFilter": { - "required": [ - "databaseKeyToMatch" - ], - "type": "object", - "properties": { - "databaseKeyToMatch": { - "type": "string", - "nullable": true - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the database key should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, - "GsaActivityLogDateFilter": { - "type": "object", - "properties": { - "dateFrom": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "dateFromInclusive": { - "type": "boolean" - }, - "dateTo": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "dateToInclusive": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntriesFilter": { - "type": "object", - "properties": { - "dateFilter": { - "$ref": "#/components/schemas/GsaActivityLogDateFilter" - }, - "usernameFilter": { - "$ref": "#/components/schemas/GsaActivityLogUsernameFilter" - }, - "applicationNamesCollectionFilter": { - "$ref": "#/components/schemas/GsaActivityLogApplicationNamesCollectionFilter" - }, - "applicationNameFilter": { - "$ref": "#/components/schemas/GsaActivityLogApplicationNameFilter" - }, - "databaseKeyFilter": { - "$ref": "#/components/schemas/GsaActivityLogDatabaseKeyFilter" - }, - "usageModeFilter": { - "$ref": "#/components/schemas/GsaActivityLogUsageModeFilter" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntriesInfo": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaActivityLogEntry" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false - }, - "GsaActivityLogEntry": { - "required": [ - "applicationNames", - "date", - "usageMode", - "username" - ], - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "username": { - "type": "string" - }, - "applicationNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "databaseKey": { - "type": "string", - "nullable": true - }, - "usageMode": { - "$ref": "#/components/schemas/GsaActivityLogUsageMode" - } - }, - "additionalProperties": false - }, - "GsaActivityLogMatchType": { - "enum": [ - "exactMatchCaseInsensitive", - "containsCaseInsensitive" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • exactMatchCaseInsensitive: Exact match case-insensitive.
    • \r\n
  • containsCaseInsensitive: Contains case-insensitive.
    • \r\n
\r\n" - }, - "GsaActivityLogUsageMode": { - "enum": [ - "view", - "edit" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • view: View.
    • \r\n
  • edit: Edit.
    • \r\n
\r\n" - }, - "GsaActivityLogUsageModeFilter": { - "required": [ - "usageModeToMatch" - ], - "type": "object", - "properties": { - "usageModeToMatch": { - "$ref": "#/components/schemas/GsaActivityLogUsageMode" - } - }, - "additionalProperties": false - }, - "GsaActivityLogUsernameFilter": { - "required": [ - "usernameToMatch" - ], - "type": "object", - "properties": { - "usernameToMatch": { - "type": "string" - }, - "matchType": { - "$ref": "#/components/schemas/GsaActivityLogMatchType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nmatchType: Defines how the username should be matched. If not specified, defaults to exactMatchCaseInsensitive." - }, "GsaAddDatabase": { "required": [ - "databaseKey", - "inputConnectionDetails" + "connectionDetails", + "databaseKey" ], "type": "object", "properties": { "databaseKey": { "type": "string" }, - "inputConnectionDetails": { - "$ref": "#/components/schemas/GsaInputConnectionDetails" + "connectionDetails": { + "$ref": "#/components/schemas/GsaConnectionDetails" }, "isReadOnly": { "type": "boolean", @@ -89591,7 +65934,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\ninputConnectionDetails: The SQL server connection details for the database" + "description": "\r\n\r\nconnectionDetails: The SQL server connection details for the database" }, "GsaAddDatabaseIssueType": { "enum": [ @@ -89607,39 +65950,6 @@ "type": "string", "description": "

Possible values:

\r\n
    \r\n
  • schemaTooNew: The specified database schema is too new, you must upgrade MI:Server before this database can be used.
    • \r\n
  • schemaTooOld: The specified database schema is too old and must be upgraded.
    • \r\n
  • duplicateGuid: Duplicate Guid.
    • \r\n
  • duplicateVersionGuid: Duplicate version Guid.
    • \r\n
  • duplicateKey: Duplicate database key.
    • \r\n
  • invalidKey: Invalid database key.
    • \r\n
  • unableToConnect: Unable to connect to database.
    • \r\n
  • duplicateDatabase: Duplicate database - this database has already been added to MI.
    • \r\n
\r\n" }, - "GsaAddDatabaseSecurityGroups": { - "required": [ - "adminGroup", - "grantGroup", - "powerUserGroup", - "readGroup", - "writeGroup" - ], - "type": "object", - "properties": { - "adminGroup": { - "type": "string", - "nullable": true - }, - "grantGroup": { - "type": "string", - "nullable": true - }, - "powerUserGroup": { - "type": "string", - "nullable": true - }, - "writeGroup": { - "type": "string", - "nullable": true - }, - "readGroup": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaAddDatabaseValidationIssue": { "required": [ "IssueType" @@ -89655,7 +65965,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDuplicateGuidAddDatabaseValidationIssue](#model-GsaDuplicateGuidAddDatabaseValidationIssue)\r\n * [GsaDuplicateVersionGuidAddDatabaseValidationIssue](#model-GsaDuplicateVersionGuidAddDatabaseValidationIssue)\r\n * [GsaDuplicateKeyAddDatabaseValidationIssue](#model-GsaDuplicateKeyAddDatabaseValidationIssue)\r\n * [GsaInvalidKeyAddDatabaseValidationIssue](#model-GsaInvalidKeyAddDatabaseValidationIssue)\r\n * [GsaSchemaTooNewAddDatabaseValidationIssue](#model-GsaSchemaTooNewAddDatabaseValidationIssue)\r\n * [GsaSchemaTooOldAddDatabaseValidationIssue](#model-GsaSchemaTooOldAddDatabaseValidationIssue)\r\n * [GsaUnableToConnectAddDatabaseValidationIssue](#model-GsaUnableToConnectAddDatabaseValidationIssue)\r\n * [GsaDuplicateDatabaseAddDatabaseValidationIssue](#model-GsaDuplicateDatabaseAddDatabaseValidationIssue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDuplicateGuidAddDatabaseValidationIssue\r\n * GsaDuplicateVersionGuidAddDatabaseValidationIssue\r\n * GsaDuplicateKeyAddDatabaseValidationIssue\r\n * GsaInvalidKeyAddDatabaseValidationIssue\r\n * GsaSchemaTooNewAddDatabaseValidationIssue\r\n * GsaSchemaTooOldAddDatabaseValidationIssue\r\n * GsaUnableToConnectAddDatabaseValidationIssue\r\n * GsaDuplicateDatabaseAddDatabaseValidationIssue", "discriminator": { "propertyName": "IssueType", "mapping": { @@ -89699,16 +66009,6 @@ }, "additionalProperties": false }, - "GsaAdditionalSqlParameters": { - "type": "object", - "properties": { - "value": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaAggregation": { "required": [ "type" @@ -89720,7 +66020,7 @@ } }, "additionalProperties": false, - "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n * [GsaFreeTextAggregation](#model-GsaFreeTextAggregation)", + "description": "The results of aggregation.\r\n\r\nThis is one of: \r\n * GsaAttributeAggregation\r\n * GsaFreeTextAggregation", "discriminator": { "propertyName": "type", "mapping": { @@ -89740,7 +66040,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n * [GsaFreeTextAggregationCriterion](#model-GsaFreeTextAggregationCriterion)", + "description": "\r\n\r\nThis is one of: \r\n * GsaAttributeAggregationCriterion\r\n * GsaFreeTextAggregationCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -89760,7 +66060,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaIntegerAggregation](#model-GsaIntegerAggregation)\r\n * [GsaPointAggregation](#model-GsaPointAggregation)\r\n * [GsaRangeAggregation](#model-GsaRangeAggregation)\r\n * [GsaIntegerHistogramAggregation](#model-GsaIntegerHistogramAggregation)\r\n * [GsaPointHistogramAggregation](#model-GsaPointHistogramAggregation)\r\n * [GsaRangeHistogramAggregation](#model-GsaRangeHistogramAggregation)\r\n * [GsaDateTimeAggregation](#model-GsaDateTimeAggregation)\r\n * [GsaDateTimeHistogramAggregation](#model-GsaDateTimeHistogramAggregation)\r\n * [GsaShortTextAggregation](#model-GsaShortTextAggregation)\r\n * [GsaDiscreteTextAggregation](#model-GsaDiscreteTextAggregation)\r\n * [GsaLinkAggregation](#model-GsaLinkAggregation)\r\n * [GsaLogicalAggregation](#model-GsaLogicalAggregation)\r\n * [GsaFloatFunctionalAggregation](#model-GsaFloatFunctionalAggregation)", + "description": "\r\n\r\nThis is one of: \r\n * GsaIntegerAggregation\r\n * GsaPointAggregation\r\n * GsaRangeAggregation\r\n * GsaIntegerHistogramAggregation\r\n * GsaPointHistogramAggregation\r\n * GsaRangeHistogramAggregation\r\n * GsaDateTimeAggregation\r\n * GsaDateTimeHistogramAggregation\r\n * GsaShortTextAggregation\r\n * GsaDiscreteTextAggregation\r\n * GsaLinkAggregation\r\n * GsaLogicalAggregation\r\n * GsaFloatFunctionalAggregation", "discriminator": { "propertyName": "datumType", "mapping": { @@ -89791,7 +66091,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDateTimeAggregationDatumCriterion](#model-GsaDateTimeAggregationDatumCriterion)\r\n * [GsaDateTimeHistogramAggregationDatumCriterion](#model-GsaDateTimeHistogramAggregationDatumCriterion)\r\n * [GsaDateTimeFixedWidthHistogramAggregationDatumCriterion](#model-GsaDateTimeFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion](#model-GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion)\r\n * [GsaDiscreteTextAggregationDatumCriterion](#model-GsaDiscreteTextAggregationDatumCriterion)\r\n * [GsaIntegerAggregationDatumCriterion](#model-GsaIntegerAggregationDatumCriterion)\r\n * [GsaPointAggregationDatumCriterion](#model-GsaPointAggregationDatumCriterion)\r\n * [GsaRangeAggregationDatumCriterion](#model-GsaRangeAggregationDatumCriterion)\r\n * [GsaIntegerHistogramAggregationDatumCriterion](#model-GsaIntegerHistogramAggregationDatumCriterion)\r\n * [GsaIntegerFixedWidthHistogramAggregationDatumCriterion](#model-GsaIntegerFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaPointHistogramAggregationDatumCriterion](#model-GsaPointHistogramAggregationDatumCriterion)\r\n * [GsaPointFixedWidthHistogramAggregationDatumCriterion](#model-GsaPointFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaRangeHistogramAggregationDatumCriterion](#model-GsaRangeHistogramAggregationDatumCriterion)\r\n * [GsaRangeFixedWidthHistogramAggregationDatumCriterion](#model-GsaRangeFixedWidthHistogramAggregationDatumCriterion)\r\n * [GsaShortTextAggregationDatumCriterion](#model-GsaShortTextAggregationDatumCriterion)\r\n * [GsaLinkAggregationDatumCriterion](#model-GsaLinkAggregationDatumCriterion)\r\n * [GsaLogicalAggregationDatumCriterion](#model-GsaLogicalAggregationDatumCriterion)\r\n * [GsaFloatFunctionalAggregationDatumCriterion](#model-GsaFloatFunctionalAggregationDatumCriterion)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDateTimeAggregationDatumCriterion\r\n * GsaDateTimeHistogramAggregationDatumCriterion\r\n * GsaDateTimeFixedWidthHistogramAggregationDatumCriterion\r\n * GsaDateTimeFixedCalendarWidthHistogramAggregationDatumCriterion\r\n * GsaDiscreteTextAggregationDatumCriterion\r\n * GsaIntegerAggregationDatumCriterion\r\n * GsaPointAggregationDatumCriterion\r\n * GsaRangeAggregationDatumCriterion\r\n * GsaIntegerHistogramAggregationDatumCriterion\r\n * GsaIntegerFixedWidthHistogramAggregationDatumCriterion\r\n * GsaPointHistogramAggregationDatumCriterion\r\n * GsaPointFixedWidthHistogramAggregationDatumCriterion\r\n * GsaRangeHistogramAggregationDatumCriterion\r\n * GsaRangeFixedWidthHistogramAggregationDatumCriterion\r\n * GsaShortTextAggregationDatumCriterion\r\n * GsaLinkAggregationDatumCriterion\r\n * GsaLogicalAggregationDatumCriterion\r\n * GsaFloatFunctionalAggregationDatumCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -89890,13 +66190,10 @@ }, "description": "The aggregations you wish to perform.", "nullable": true - }, - "tableSearchBehaviour": { - "$ref": "#/components/schemas/GsaTableSearchBehaviour" } }, "additionalProperties": false, - "description": "A request for aggregation information from a particular scope. The type of information\r\nrequested can vary: for example, for attributes, it could be a request for minimum/maximum\r\nvalues, or for common text terms.\r\n \r\nAn aggregation request is associated with a particular scope (database, table, integration\r\nschema, etc) based off the API invoked; however, the scope can be further narrowed down by\r\nproviding a criterion in the aggregation request. Only data from records matching that\r\ncriterion will be considered when aggregating data.\r\n \r\nNote that only some types of criterion will be supported: in particular, criteria that involve\r\n\"matches\" criteria against functional attributes, or link-attribute criteria against record\r\nlink groups, are not eligible to be used as an aggregation query criterion.\r\n\r\ncriterion: An optional query criterion, to be used to filter the collection of records to aggregate over.\r\n\r\ntableSearchBehaviour: Determines the behaviour of records in tables that are marked as hidden from search. The default behaviour is that these records are excluded." + "description": "A request for aggregation information from a particular scope. The type of information\r\nrequested can vary: for example, for attributes, it could be a request for minimum/maximum\r\nvalues, or for common text terms.\r\n \r\nAn aggregation request is associated with a particular scope (database, table, integration\r\nschema, etc) based off the API invoked; however, the scope can be further narrowed down by\r\nproviding a criterion in the aggregation request. Only data from records matching that\r\ncriterion will be considered when aggregating data.\r\n \r\nNote that only some types of criterion will be supported: in particular, criteria that involve\r\n\"matches\" criteria against functional attributes, or link-attribute criteria against record\r\nlink groups, are not eligible to be used as an aggregation query criterion.\r\n\r\ncriterion: An optional query criterion, to be used to filter the collection of records to aggregate over." }, "GsaAggregationsResponse": { "required": [ @@ -89941,7 +66238,7 @@ } ], "additionalProperties": false, - "description": "Specifies no filtering.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'all'", + "description": "Specifies no filtering.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'all'", "x-discriminator-value": "all", "x-discriminator-name": "filterOn" }, @@ -89956,7 +66253,7 @@ } ], "additionalProperties": false, - "description": "Anonymous expressions cannot be allowed without allowing all compatible expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'anonymousExpressionsMustAllowAllCompatible'", + "description": "Anonymous expressions cannot be allowed without allowing all compatible expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'anonymousExpressionsMustAllowAllCompatible'", "x-discriminator-value": "anonymousExpressionsMustAllowAllCompatible", "x-discriminator-name": "reason" }, @@ -90067,7 +66364,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatum](#model-GsaDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * [GsaIntegerDatum](#model-GsaIntegerDatum)\r\n * [GsaLogicalDatum](#model-GsaLogicalDatum)\r\n * [GsaShortTextDatum](#model-GsaShortTextDatum)\r\n * [GsaLongTextDatum](#model-GsaLongTextDatum)\r\n * [GsaHyperlinkDatum](#model-GsaHyperlinkDatum)\r\n * [GsaDateTimeDatum](#model-GsaDateTimeDatum)\r\n * [GsaDiscreteDatum](#model-GsaDiscreteDatum)\r\n * [GsaRangeDatum](#model-GsaRangeDatum)\r\n * [GsaPointDatum](#model-GsaPointDatum)\r\n * [GsaPictureDatum](#model-GsaPictureDatum)\r\n * [GsaFileDatum](#model-GsaFileDatum)\r\n * [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n * [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n * [GsaTabularDatum](#model-GsaTabularDatum)", + "description": "\r\n\r\nThis extends: GsaDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * GsaIntegerDatum\r\n * GsaLogicalDatum\r\n * GsaShortTextDatum\r\n * GsaLongTextDatum\r\n * GsaHyperlinkDatum\r\n * GsaDateTimeDatum\r\n * GsaDiscreteDatum\r\n * GsaRangeDatum\r\n * GsaPointDatum\r\n * GsaPictureDatum\r\n * GsaFileDatum\r\n * GsaFloatFunctionalDatum\r\n * GsaDiscreteFunctionalDatum\r\n * GsaTabularDatum", "x-discriminator-value": "applicable", "x-discriminator-name": "notApplicable" }, @@ -90084,56 +66381,6 @@ }, "additionalProperties": false }, - "GsaApplyOptions": { - "required": [ - "applyAddsAsState", - "matchMode", - "retargetTabularAttributes" - ], - "type": "object", - "properties": { - "matchMode": { - "$ref": "#/components/schemas/GsaMatchMode" - }, - "applyAddsAsState": { - "type": "boolean" - }, - "retargetTabularAttributes": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaAssociationChainCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "associationChainLinks", - "associationChainName" - ], - "type": "object", - "properties": { - "associationChainName": { - "type": "string" - }, - "associationChainLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAssociationChainLink" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", - "x-discriminator-value": "associationChain", - "x-discriminator-name": "itemType" - }, "GsaAttribute": { "required": [ "defaultThresholdType", @@ -90141,7 +66388,6 @@ "guid", "info", "isHiddenFromSearchCriteria", - "isProtected", "name", "table", "type" @@ -90171,10 +66417,6 @@ "type": "boolean", "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, "table": { "$ref": "#/components/schemas/GsaSlimEntity" }, @@ -90183,8 +66425,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -90195,7 +66436,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaPointAttribute](#model-GsaPointAttribute)\r\n * [GsaIntegerAttribute](#model-GsaIntegerAttribute)\r\n * [GsaRangeAttribute](#model-GsaRangeAttribute)\r\n * [GsaLogicalAttribute](#model-GsaLogicalAttribute)\r\n * [GsaShortTextAttribute](#model-GsaShortTextAttribute)\r\n * [GsaLongTextAttribute](#model-GsaLongTextAttribute)\r\n * [GsaDateTimeAttribute](#model-GsaDateTimeAttribute)\r\n * [GsaDiscreteAttribute](#model-GsaDiscreteAttribute)\r\n * [GsaHyperlinkAttribute](#model-GsaHyperlinkAttribute)\r\n * [GsaFileAttribute](#model-GsaFileAttribute)\r\n * [GsaPictureAttribute](#model-GsaPictureAttribute)\r\n * [GsaTabularAttribute](#model-GsaTabularAttribute)\r\n * [GsaFloatFunctionalAttribute](#model-GsaFloatFunctionalAttribute)\r\n * [GsaDiscreteFunctionalAttribute](#model-GsaDiscreteFunctionalAttribute)\r\n * [GsaMathsFunctionalAttribute](#model-GsaMathsFunctionalAttribute)", + "description": "\r\n\r\nThis is one of: \r\n * GsaPointAttribute\r\n * GsaIntegerAttribute\r\n * GsaRangeAttribute\r\n * GsaLogicalAttribute\r\n * GsaShortTextAttribute\r\n * GsaLongTextAttribute\r\n * GsaDateTimeAttribute\r\n * GsaDiscreteAttribute\r\n * GsaHyperlinkAttribute\r\n * GsaFileAttribute\r\n * GsaPictureAttribute\r\n * GsaTabularAttribute\r\n * GsaFloatFunctionalAttribute\r\n * GsaDiscreteFunctionalAttribute\r\n * GsaMathsFunctionalAttribute", "discriminator": { "propertyName": "type", "mapping": { @@ -90260,7 +66501,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over an attribute. In all cases this will report the number of records in\r\nthe aggregation scope that have a value for the attribute. In some cases, depending on the attribute\r\ntype, we may be able to report more information. For example, aggregating over a numeric attribute will\r\nalso provide the minimum and maximum values that attribute takes across records in the aggregation\r\nscope.\r\n\r\nThis extends: [GsaAggregation](#model-GsaAggregation)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeValueAggregation](#model-GsaAttributeValueAggregation)\r\n * [GsaAttributeExistsAggregation](#model-GsaAttributeExistsAggregation)", + "description": "The results of aggregation over an attribute. In all cases this will report the number of records in\r\nthe aggregation scope that have a value for the attribute. In some cases, depending on the attribute\r\ntype, we may be able to report more information. For example, aggregating over a numeric attribute will\r\nalso provide the minimum and maximum values that attribute takes across records in the aggregation\r\nscope.\r\n\r\nThis extends: GsaAggregation\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeValueAggregation\r\n * GsaAttributeExistsAggregation", "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, @@ -90303,7 +66544,7 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute. Exactly one of the identity or GUID must be provided.\r\n\r\nThis extends: [GsaAggregationCriterion](#model-GsaAggregationCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeAggregationValueCriterion](#model-GsaAttributeAggregationValueCriterion)\r\n * [GsaAttributeAggregationExistsCriterion](#model-GsaAttributeAggregationExistsCriterion)", + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute. Exactly one of the identity or GUID must be provided.\r\n\r\nThis extends: GsaAggregationCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeAggregationValueCriterion\r\n * GsaAttributeAggregationExistsCriterion", "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, @@ -90326,7 +66567,7 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'exists'", + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute.\r\n\r\nThis extends: GsaAttributeAggregationCriterion\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "attributeAggregationCriterionType" }, @@ -90354,107 +66595,10 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute,\r\nincluding summary information about the values assumed by the attribute.\r\n \r\nFor a numeric attribute (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the attribute on some record.\r\n \r\nFor a simple text attribute (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that attribute.\r\n \r\nThis can also be used within the inner criteria of a 'link' attribute aggregation, to request\r\nan aggregation over a local tabular column.\r\n\r\nThis extends: [GsaAttributeAggregationCriterion](#model-GsaAttributeAggregationCriterion)\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'value'", + "description": "A criterion for requesting aggregations for a single specific attribute or meta-attribute,\r\nincluding summary information about the values assumed by the attribute.\r\n \r\nFor a numeric attribute (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the attribute on some record.\r\n \r\nFor a simple text attribute (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that attribute.\r\n \r\nThis can also be used within the inner criteria of a 'link' attribute aggregation, to request\r\nan aggregation over a local tabular column.\r\n\r\nThis extends: GsaAttributeAggregationCriterion\r\n\r\nThe value of discriminator property ('attributeAggregationCriterionType') must be equal to 'value'", "x-discriminator-value": "value", "x-discriminator-name": "attributeAggregationCriterionType" }, - "GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "attributeGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Smart record link group source and target attributes cannot contain duplicates.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeAlreadySpecified'", - "x-discriminator-value": "attributeAlreadySpecified", - "x-discriminator-name": "reason" - }, - "GsaAttributeBasedAccessControlInfo": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlInfo" - }, - { - "required": [ - "currentRuleEngine" - ], - "type": "object", - "properties": { - "currentRuleEngine": { - "$ref": "#/components/schemas/GsaRuleEngine" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlInfo](#model-GsaAccessControlInfo)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'attributeBased'", - "x-discriminator-value": "attributeBased", - "x-discriminator-name": "mode" - }, - "GsaAttributeCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "attributeGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "required": { - "type": "boolean" - }, - "readOnly": { - "type": "boolean" - }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutAttributeItem" - }, - "nullable": true - }, - "tabularColumnGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" - }, "GsaAttributeCreationException": { "type": "object", "properties": { @@ -90463,7 +66607,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -90515,7 +66659,7 @@ } ], "additionalProperties": false, - "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * [GsaAttributeMatchesCriterion](#model-GsaAttributeMatchesCriterion)\r\n * [GsaAttributeExistsCriterion](#model-GsaAttributeExistsCriterion)\r\n * [GsaAttributeNotApplicableCriterion](#model-GsaAttributeNotApplicableCriterion)", + "description": "Base class for attribute criterions. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'\r\n\r\nThis is one of: \r\n * GsaAttributeMatchesCriterion\r\n * GsaAttributeExistsCriterion\r\n * GsaAttributeNotApplicableCriterion", "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, @@ -90528,9 +66672,6 @@ "type": "string" }, "GsaAttributeDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -90538,12 +66679,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -90555,40 +66691,6 @@ }, "additionalProperties": false }, - "GsaAttributeDiscreteTypeMismatchErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "actualDiscreteTypeGuid", - "attributeGuid", - "expectedDiscreteTypeGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "expectedDiscreteTypeGuid": { - "type": "string", - "format": "uuid" - }, - "actualDiscreteTypeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeDiscreteTypeMismatch'", - "x-discriminator-value": "attributeDiscreteTypeMismatch", - "x-discriminator-name": "reason" - }, "GsaAttributeErrorDetail": { "required": [ "message", @@ -90604,7 +66706,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAboutAttributeCannotBeMetaAttributeErrorDetail](#model-GsaAboutAttributeCannotBeMetaAttributeErrorDetail)\r\n * [GsaDuplicateParameterGuidsAttributeErrorDetail](#model-GsaDuplicateParameterGuidsAttributeErrorDetail)\r\n * [GsaEmptyAxisNameAttributeErrorDetail](#model-GsaEmptyAxisNameAttributeErrorDetail)\r\n * [GsaFuncNoParamsAttributeErrorDetail](#model-GsaFuncNoParamsAttributeErrorDetail)\r\n * [GsaMathsFunctionalAttributeErrorDetail](#model-GsaMathsFunctionalAttributeErrorDetail)\r\n * [GsaMissingParameterGuidAttributeErrorDetail](#model-GsaMissingParameterGuidAttributeErrorDetail)\r\n * [GsaNamedEntityAttributeErrorDetail](#model-GsaNamedEntityAttributeErrorDetail)\r\n * [GsaNoSuchEntityAttributeErrorDetail](#model-GsaNoSuchEntityAttributeErrorDetail)\r\n * [GsaPointParametersRequiresMultiValuedAttributeErrorDetail](#model-GsaPointParametersRequiresMultiValuedAttributeErrorDetail)\r\n * [GsaTargetAttributeNotInTableAttributeErrorDetail](#model-GsaTargetAttributeNotInTableAttributeErrorDetail)\r\n * [GsaTargetAttributeTypeAttributeErrorDetail](#model-GsaTargetAttributeTypeAttributeErrorDetail)\r\n * [GsaThresholdTypeAttributeErrorDetail](#model-GsaThresholdTypeAttributeErrorDetail)\r\n * [GsaDuplicateTabularColumnGuidsErrorDetail](#model-GsaDuplicateTabularColumnGuidsErrorDetail)\r\n * [GsaExistingTabularColumnGuidErrorDetail](#model-GsaExistingTabularColumnGuidErrorDetail)\r\n * [GsaTabularColumnNameNotProvidedErrorDetail](#model-GsaTabularColumnNameNotProvidedErrorDetail)\r\n * [GsaDuplicateTabularColumnNamesErrorDetail](#model-GsaDuplicateTabularColumnNamesErrorDetail)\r\n * [GsaNoSuchEntityTabularColumnErrorDetail](#model-GsaNoSuchEntityTabularColumnErrorDetail)\r\n * [GsaMetaAttributeCannotHaveMetaAttributeErrorDetail](#model-GsaMetaAttributeCannotHaveMetaAttributeErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaAboutAttributeCannotBeMetaAttributeErrorDetail\r\n * GsaDuplicateParameterGuidsAttributeErrorDetail\r\n * GsaEmptyAxisNameAttributeErrorDetail\r\n * GsaFuncNoParamsAttributeErrorDetail\r\n * GsaMathsFunctionalAttributeErrorDetail\r\n * GsaMissingParameterGuidAttributeErrorDetail\r\n * GsaNamedEntityAttributeErrorDetail\r\n * GsaNoSuchEntityAttributeErrorDetail\r\n * GsaPointParametersRequiresMultiValuedAttributeErrorDetail\r\n * GsaTargetAttributeNotInTableAttributeErrorDetail\r\n * GsaTargetAttributeTypeAttributeErrorDetail\r\n * GsaThresholdTypeAttributeErrorDetail\r\n * GsaDuplicateTabularColumnGuidsErrorDetail\r\n * GsaExistingTabularColumnGuidErrorDetail\r\n * GsaTabularColumnNameNotProvidedErrorDetail\r\n * GsaDuplicateTabularColumnNamesErrorDetail\r\n * GsaNoSuchEntityTabularColumnErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -90624,15 +66726,13 @@ "existingTabularColumnGuid": "#/components/schemas/GsaExistingTabularColumnGuidErrorDetail", "tabularColumnNameNotProvided": "#/components/schemas/GsaTabularColumnNameNotProvidedErrorDetail", "duplicateTabularColumnNames": "#/components/schemas/GsaDuplicateTabularColumnNamesErrorDetail", - "tabularColumnNoSuchEntity": "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail", - "metaAttributeCannotHaveMetaAttribute": "#/components/schemas/GsaMetaAttributeCannotHaveMetaAttributeErrorDetail" + "tabularColumnNoSuchEntity": "#/components/schemas/GsaNoSuchEntityTabularColumnErrorDetail" } } }, "GsaAttributeErrorReason": { "enum": [ "aboutAttributeCannotBeMeta", - "metaAttributeCannotHaveMetaAttribute", "duplicateParameterGuids", "emptyAxisName", "funcNoParams", @@ -90650,8 +66750,7 @@ "duplicateTabularColumnNames", "tabularColumnNoSuchEntity" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • aboutAttributeCannotBeMeta: Cannot have a meta-attribute as an 'About attribute'.
    • \r\n
  • metaAttributeCannotHaveMetaAttribute: Meta-attribute cannot have a meta-attribute.
    • \r\n
  • duplicateParameterGuids: No duplicate parameter GUIDs allowed.
    • \r\n
  • emptyAxisName: Axis name cannot be empty or whitespace.
    • \r\n
  • funcNoParams: Functional attributes must have at least one parameter. Functional attributes only.
    • \r\n
  • mathsFunctional: Errors specific to Maths Functional attributes. See \"errors\" for details.
    • \r\n
  • missingParameterGuid: All supplied attribute parameters must have parameter GUIDs specified.
    • \r\n
  • namedEntity: The name or GUID is not valid. See \"errors\" for details.
    • \r\n
  • noSuchEntity: Could not find the entityType with the given GUID.
    • \r\n
  • pointParametersRequiresMultiValued: Only attributes marked as multi-valued can be parameterized. Point attributes only.
    • \r\n
  • targetAttributeNotInTable: The target attribute is not valid as it does not belong to the target table. Tabular attributes only.
    • \r\n
  • targetAttributeType: The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute. Tabular attributes only.
    • \r\n
  • thresholdType: Threshold type is not allowed for this attribute type.
    • \r\n
  • duplicateTabularColumnGuids: No duplicate tabular column GUIDs allowed.
    • \r\n
  • existingTabularColumnGuid: Tabular column with GUID already exists.
    • \r\n
  • tabularColumnNameNotProvided: Tabular Column must have a name.
    • \r\n
  • duplicateTabularColumnNames: No duplicate tabular column names allowed.
    • \r\n
  • tabularColumnNoSuchEntity: Could not find the entityType with the given GUID.
    • \r\n
\r\n" + "type": "string" }, "GsaAttributeExistsAggregation": { "type": "object", @@ -90664,7 +66763,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over an attribute, reporting only the number of records with a value\r\nfor the attribute.\r\n\r\nThis extends: [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'exists'", + "description": "The results of aggregation over an attribute, reporting only the number of records with a value\r\nfor the attribute.\r\n\r\nThis extends: GsaAttributeAggregation\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "attributeAggregationType" }, @@ -90687,7 +66786,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching record where there is data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'exists'", + "description": "Criterion for matching record where there is data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "attributeCriterionType" }, @@ -90713,7 +66812,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, @@ -90777,14 +66876,14 @@ "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "primarySmartLinkGroups": { + "primaryDynamicLinkGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" }, "nullable": true }, - "foreignSmartLinkGroups": { + "foreignDynamicLinkGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" @@ -90805,17 +66904,13 @@ "description": "

Possible values:

\r\n
    \r\n
  • auto: The default interpolation method should be applied.
    • \r\n
  • none: No interpolation should be performed to infer values between data points.
    • \r\n
  • linear: Linear interpolation should be performed to infer values between data points.
    • \r\n
  • cubicSpline: Cubic-spline interpolation should be performed to infer values between data points.
    • \r\n
\r\n" }, "GsaAttributeLinkPair": { - "required": [ - "attributeSource", - "attributeTarget" - ], "type": "object", "properties": { "attributeSource": { - "$ref": "#/components/schemas/GsaTargetAttribute" + "$ref": "#/components/schemas/GsaSlimAttribute" }, "attributeTarget": { - "$ref": "#/components/schemas/GsaTargetAttribute" + "$ref": "#/components/schemas/GsaSlimAttribute" } }, "additionalProperties": false @@ -90839,7 +66934,7 @@ } ], "additionalProperties": false, - "description": "Criterion for a search matching values in a given attribute. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'matches'", + "description": "Criterion for a search matching values in a given attribute. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'matches'", "x-discriminator-value": "matches", "x-discriminator-name": "attributeCriterionType" }, @@ -90863,97 +66958,10 @@ } ], "additionalProperties": false, - "description": "Criterion for matching record where there is not applicable data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'notApplicable'", + "description": "Criterion for matching record where there is not applicable data on the attribute specified. Exactly one of the attribute identity or GUID must be provided.\r\n\r\nThis extends: GsaAttributeCriterion\r\n\r\nThe value of discriminator property ('attributeCriterionType') must be equal to 'notApplicable'", "x-discriminator-value": "notApplicable", "x-discriminator-name": "attributeCriterionType" }, - "GsaAttributeNotOnTableErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "attributeGuid", - "tableGuid" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeNotOnTable'", - "x-discriminator-value": "attributeNotOnTable", - "x-discriminator-name": "reason" - }, - "GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "sourceAttributeGuid", - "targetAttributeGuid" - ], - "type": "object", - "properties": { - "sourceAttributeGuid": { - "type": "string", - "format": "uuid" - }, - "targetAttributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Discrete attributes in attribute pairs must have the same discrete type.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributePairDiscreteTypeMismatch'", - "x-discriminator-value": "attributePairDiscreteTypeMismatch", - "x-discriminator-name": "reason" - }, - "GsaAttributePairTypeMismatchSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "sourceAttributeGuid", - "targetAttributeGuid" - ], - "type": "object", - "properties": { - "sourceAttributeGuid": { - "type": "string", - "format": "uuid" - }, - "targetAttributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Attributes in attribute pairs must have the same attribute type.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributePairTypeMismatch'", - "x-discriminator-value": "attributePairTypeMismatch", - "x-discriminator-name": "reason" - }, "GsaAttributeReference": { "required": [ "databaseKey" @@ -91014,7 +67022,7 @@ } ], "additionalProperties": false, - "description": "Specifies an attribute based sort criterion for a search query. Either the GUID or identity of the sorting attribute must be provided.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", + "description": "Specifies an attribute based sort criterion for a search query. Either the GUID or identity of the sorting attribute must be provided.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'attribute'", "x-discriminator-value": "attribute", "x-discriminator-name": "type" }, @@ -91056,7 +67064,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaLinkAttributeToExport](#model-GsaLinkAttributeToExport)\r\n * [GsaSimpleAttributeToExport](#model-GsaSimpleAttributeToExport)", + "description": "\r\n\r\nThis is one of: \r\n * GsaLinkAttributeToExport\r\n * GsaSimpleAttributeToExport", "discriminator": { "propertyName": "attributeType", "mapping": { @@ -91087,34 +67095,6 @@ "type": "string", "description": "The types of attribute that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • point: Point
    • \r\n
  • range: Range
    • \r\n
  • logical: Logical
    • \r\n
  • shortText: Short Text
    • \r\n
  • longText: Long Text
    • \r\n
  • dateTime: Date and Time
    • \r\n
  • discrete: Discrete Value
    • \r\n
  • hyperlink: Hyperlink
    • \r\n
  • file: File
    • \r\n
  • picture: Picture
    • \r\n
  • link: Link
    • \r\n
  • floatFunctional: Float functional
    • \r\n
  • discreteFunctional: Discrete functional
    • \r\n
  • mathsFunctional: Maths functional. Also known as Embedded Equations and Logic (EEL).
    • \r\n
  • tabular: Tabular data
    • \r\n
\r\n" }, - "GsaAttributeTypeNotSupportedSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "attributeGuid", - "attributeType" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - } - } - } - ], - "additionalProperties": false, - "description": "Attribute type is not supported in smart link group attribute pairs.\r\nAttribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'attributeTypeNotSupported'", - "x-discriminator-value": "attributeTypeNotSupported", - "x-discriminator-name": "reason" - }, "GsaAttributeUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -91135,7 +67115,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'attribute'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'attribute'", "x-discriminator-value": "attribute", "x-discriminator-name": "referencedByType" }, @@ -91174,7 +67154,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over an attribute, reporting the number of records that have a value for\r\nthe attribute, plus additional aggregation information about the attribute values. The exact type of\r\nadditional information will depend on the type of attribute.\r\n\r\naggregationDatum: The type of datum associated with this attribute. (Note: a tabular attribute will be listed as type 'link'.)\r\n\r\nThis extends: [GsaAttributeAggregation](#model-GsaAttributeAggregation)\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'value'", + "description": "The results of aggregation over an attribute, reporting the number of records that have a value for\r\nthe attribute, plus additional aggregation information about the attribute values. The exact type of\r\nadditional information will depend on the type of attribute.\r\n\r\naggregationDatum: The type of datum associated with this attribute. (Note: a tabular attribute will be listed as type 'link'.)\r\n\r\nThis extends: GsaAttributeAggregation\r\n\r\nThe value of discriminator property ('attributeAggregationType') must be equal to 'value'", "x-discriminator-value": "value", "x-discriminator-name": "attributeAggregationType" }, @@ -91213,36 +67193,6 @@ }, "additionalProperties": false }, - "GsaBlobInfoDto": { - "required": [ - "fullPath", - "lastWriteTimeUtc", - "length", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the blob." - }, - "fullPath": { - "type": "string", - "description": "Full path of the blob.\r\nPath segments are separated by '/'\r\nThe last segment is always blob name." - }, - "length": { - "type": "integer", - "description": "Blob size in bytes.", - "format": "int64" - }, - "lastWriteTimeUtc": { - "type": "string", - "description": "Last modification date.", - "format": "date-time" - } - }, - "additionalProperties": false - }, "GsaBooleanCriterion": { "type": "object", "allOf": [ @@ -91280,7 +67230,7 @@ } ], "additionalProperties": false, - "description": "boolean: Criterion that wraps other criteria in order to specify how the results should be joined together.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'boolean'", + "description": "boolean: Criterion that wraps other criteria in order to specify how the results should be joined together.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'boolean'", "x-discriminator-value": "boolean", "x-discriminator-name": "type" }, @@ -91312,21 +67262,6 @@ }, "additionalProperties": false }, - "GsaBracketMismatchUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'bracketMismatch'", - "x-discriminator-value": "bracketMismatch", - "x-discriminator-name": "reason" - }, "GsaBulkInfo": { "required": [ "data" @@ -91445,149 +67380,6 @@ "type": "string", "description": "

Possible values:

\r\n
    \r\n
  • minute: Minute
    • \r\n
  • hour: Hour
    • \r\n
  • day: Day
    • \r\n
  • week: Week
    • \r\n
  • month: Month
    • \r\n
  • quarter: Quarter
    • \r\n
  • year: Year
    • \r\n
\r\n" }, - "GsaCategoryReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The category is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'category'", - "x-discriminator-value": "category", - "x-discriminator-name": "reason" - }, - "GsaChartData": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaChartDataType" - }, - "recordVersionGuid": { - "type": "string", - "description": "The record version associated with this chart data.", - "format": "uuid" - }, - "bubbleAxisValue": { - "$ref": "#/components/schemas/GsaDataExportRange" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nbubbleAxisValue: The numeric range to for plotting on a bubble chart.\r\n\r\nThis is one of: \r\n * [GsaPointChartData](#model-GsaPointChartData)\r\n * [GsaIntegerChartData](#model-GsaIntegerChartData)\r\n * [GsaRangeChartData](#model-GsaRangeChartData)\r\n * [GsaLogicalChartData](#model-GsaLogicalChartData)\r\n * [GsaDiscreteChartData](#model-GsaDiscreteChartData)", - "discriminator": { - "propertyName": "type", - "mapping": { - "point": "#/components/schemas/GsaPointChartData", - "integer": "#/components/schemas/GsaIntegerChartData", - "range": "#/components/schemas/GsaRangeChartData", - "logical": "#/components/schemas/GsaLogicalChartData", - "discrete": "#/components/schemas/GsaDiscreteChartData" - } - } - }, - "GsaChartDataType": { - "enum": [ - "integer", - "point", - "range", - "logical", - "discrete" - ], - "type": "string", - "description": "The types of chart data that are supported by the API.

Possible values:

\r\n
    \r\n
  • integer: Integer
    • \r\n
  • point: Point
    • \r\n
  • range: Range
    • \r\n
  • logical: Logical
    • \r\n
  • discrete: Discrete Value
    • \r\n
\r\n" - }, - "GsaCircularReferenceFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Circular reference found - you cannot move a folder to be a child of one of its descendants.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'circularReference'", - "x-discriminator-value": "circularReference", - "x-discriminator-name": "reason" - }, - "GsaCodeMissingCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency must have a code.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'codeMissing'", - "x-discriminator-value": "codeMissing", - "x-discriminator-name": "reason" - }, - "GsaCodeWhitespaceCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency code must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'codeWhitespace'", - "x-discriminator-value": "codeWhitespace", - "x-discriminator-name": "reason" - }, - "GsaConfigInvalidJsonFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Configuration's value must be valid JSON.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'configInvalidJson'", - "x-discriminator-value": "configInvalidJson", - "x-discriminator-name": "reason" - }, "GsaConfiguration": { "required": [ "guid", @@ -91613,26 +67405,6 @@ }, "additionalProperties": false }, - "GsaConfigurationDetails": { - "required": [ - "connectionDetails", - "enabled", - "language" - ], - "type": "object", - "properties": { - "language": { - "type": "string" - }, - "connectionDetails": { - "$ref": "#/components/schemas/GsaConnectionDetails" - }, - "enabled": { - "type": "boolean" - } - }, - "additionalProperties": false - }, "GsaConfigurationsInfo": { "required": [ "configurations" @@ -91659,26 +67431,28 @@ "type": "string", "description": "The SQL server data source" }, - "initialCatalog": { - "type": "string", - "description": "The name of the database in SQL server" - }, - "useConfigurationDatabaseCredentials": { - "type": "boolean", - "description": "Set to true if the SQL connection is using the credentials from the Configuration database." - }, "useIntegratedSecurity": { "type": "boolean", - "description": "Set to true if the SQL connection to the database is using Windows authentication" + "description": "Set to true if the SQL connection to the new database should use Windows authentication", + "nullable": true }, "sqlUsername": { "type": "string", - "description": "The username used if the database is using SQL authentication.", + "description": "The username to use if the new database should use SQL authentication. The password must also be provided.", + "nullable": true + }, + "sqlPassword": { + "type": "string", + "description": "The password to use if the new database should use SQL authentication. The username must also be provided.", "nullable": true }, + "initialCatalog": { + "type": "string", + "description": "The name of the database in SQL server" + }, "additionalSqlParameters": { "type": "string", - "description": "(Optional) Any additional parameters added to the SQL connection string for the database.", + "description": "(Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format.", "nullable": true } }, @@ -91710,34 +67484,7 @@ "additionalProperties": false, "description": "Constant used in equations" }, - "GsaConstantCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaConstantDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -91745,12 +67492,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -91762,127 +67504,19 @@ }, "additionalProperties": false }, - "GsaConstantErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaConstantErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityConstantErrorDetail](#model-GsaNamedEntityConstantErrorDetail)\r\n * [GsaNoSuchUnitConstantErrorDetail](#model-GsaNoSuchUnitConstantErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityConstantErrorDetail", - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitConstantErrorDetail" - } - } - }, - "GsaConstantErrorReason": { - "enum": [ - "namedEntity", - "noSuchUnit" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
\r\n" - }, - "GsaConstantUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "constantGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaConstantUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'constant'", - "x-discriminator-value": "constant", - "x-discriminator-name": "referencedByType" - }, "GsaConstantsInfo": { "type": "object", "properties": { "constants": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaConstant" + "$ref": "#/components/schemas/GsaSlimConstant" }, "nullable": true } }, "additionalProperties": false }, - "GsaContinuousQualitySystem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - { - "required": [ - "doesQualityIncreaseWithValue", - "thresholdValue" - ], - "type": "object", - "properties": { - "doesQualityIncreaseWithValue": { - "type": "boolean" - }, - "thresholdValue": { - "type": "number", - "format": "double" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystem](#model-GsaQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'continuous'", - "x-discriminator-value": "continuous", - "x-discriminator-name": "type" - }, "GsaContinuousRange": { "type": "object", "properties": { @@ -91918,57 +67552,6 @@ }, "additionalProperties": false }, - "GsaCreateAccessControlCategory": { - "required": [ - "discreteType", - "name" - ], - "type": "object", - "properties": { - "discreteType": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAccessControlCategoryTableMapping" - }, - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateAccessControlCategoryTableMapping": { - "required": [ - "attribute", - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "description": "The values applied to the table for this category.", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaCreateAttribute": { "required": [ "name", @@ -91991,22 +67574,6 @@ "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches.\r\nIf not specified, it will be set to the default value for the attribute type.", "nullable": true }, - "metaAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttribute" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Set a display name for different languages.\r\nSupported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\".", - "nullable": true - }, "name": { "type": "string" }, @@ -92016,7 +67583,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\ndefaultThresholdType: The default threshold type for this attribute when used in searching. Allowed values depend on the attribute type as follows: - shortText: exists, doesNotExist, equal, contains, none - longText, file, hyperlink: exists, doesNotExist, contains, none - logical: exists, doesNotExist, equal, none - picture, link, tabular: exists, doesNotExist, none - point, range, integer, date, floatFunctional, mathsFunctional: exists, doesNotExist, atLeast, atMost, equal, between, none - discrete: exists, doesNotExist, atLeast, atMost, equal, isOneOf, isNot, isAllOf, none - discreteFunctional: exists, doesNotExist, atLeast, atMost, equal, isOneOf, none\r\n\r\nThis is one of: \r\n * [GsaCreatePointAttribute](#model-GsaCreatePointAttribute)\r\n * [GsaCreateIntegerAttribute](#model-GsaCreateIntegerAttribute)\r\n * [GsaCreateRangeAttribute](#model-GsaCreateRangeAttribute)\r\n * [GsaCreateLogicalAttribute](#model-GsaCreateLogicalAttribute)\r\n * [GsaCreateShortTextAttribute](#model-GsaCreateShortTextAttribute)\r\n * [GsaCreateLongTextAttribute](#model-GsaCreateLongTextAttribute)\r\n * [GsaCreateDateTimeAttribute](#model-GsaCreateDateTimeAttribute)\r\n * [GsaCreateDiscreteAttribute](#model-GsaCreateDiscreteAttribute)\r\n * [GsaCreateHyperlinkAttribute](#model-GsaCreateHyperlinkAttribute)\r\n * [GsaCreateFileAttribute](#model-GsaCreateFileAttribute)\r\n * [GsaCreatePictureAttribute](#model-GsaCreatePictureAttribute)\r\n * [GsaCreateTabularAttribute](#model-GsaCreateTabularAttribute)\r\n * [GsaCreateFloatFunctionalAttribute](#model-GsaCreateFloatFunctionalAttribute)\r\n * [GsaCreateDiscreteFunctionalAttribute](#model-GsaCreateDiscreteFunctionalAttribute)\r\n * [GsaCreateMathsFunctionalAttribute](#model-GsaCreateMathsFunctionalAttribute)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreatePointAttribute\r\n * GsaCreateIntegerAttribute\r\n * GsaCreateRangeAttribute\r\n * GsaCreateLogicalAttribute\r\n * GsaCreateShortTextAttribute\r\n * GsaCreateLongTextAttribute\r\n * GsaCreateDateTimeAttribute\r\n * GsaCreateDiscreteAttribute\r\n * GsaCreateHyperlinkAttribute\r\n * GsaCreateFileAttribute\r\n * GsaCreatePictureAttribute\r\n * GsaCreateTabularAttribute\r\n * GsaCreateFloatFunctionalAttribute\r\n * GsaCreateDiscreteFunctionalAttribute\r\n * GsaCreateMathsFunctionalAttribute", "discriminator": { "propertyName": "type", "mapping": { @@ -92054,8 +67621,7 @@ "format": "uuid" } }, - "additionalProperties": false, - "description": "Attribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText." + "additionalProperties": false }, "GsaCreateAxisName": { "required": [ @@ -92137,25 +67703,6 @@ }, "additionalProperties": false }, - "GsaCreateCrossDatabaseLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "databaseGuid": { - "type": "string", - "description": "If databaseGuid is set, the target will match any database with that Guid.\r\nIf databaseGuid is not set, the target wil match the tableGuid in any database.", - "format": "uuid", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaCreateCrossDatabaseRecordLinkGroup": { "type": "object", "allOf": [ @@ -92163,14 +67710,8 @@ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, { - "required": [ - "linkTarget" - ], "type": "object", "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateCrossDatabaseLinkTarget" - }, "includeIndirectLinks": { "type": "boolean" } @@ -92178,7 +67719,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", "x-discriminator-value": "crossDatabase", "x-discriminator-name": "type" }, @@ -92206,26 +67747,6 @@ }, "additionalProperties": false }, - "GsaCreateDataUpdateServerApiRequest": { - "required": [ - "name", - "project" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "project": { - "$ref": "#/components/schemas/GsaDataUpdaterProject" - } - }, - "additionalProperties": false - }, "GsaCreateDateTimeAttribute": { "type": "object", "allOf": [ @@ -92237,7 +67758,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, @@ -92263,7 +67784,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92293,7 +67814,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "type" }, @@ -92313,7 +67834,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaCreateDiscreteFunctionalAttributeParameter](#model-GsaCreateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaCreateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92336,7 +67857,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateDiscreteFunctionalAttributeParameter](#model-GsaCreateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaCreateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -92355,7 +67876,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteFunctionalAttributeDiscreteParameter](#model-GsaCreateDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaCreateDiscreteFunctionalAttributeNumericParameter](#model-GsaCreateDiscreteFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaCreateDiscreteFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -92386,7 +67907,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameter](#model-GsaCreateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92409,7 +67930,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterContent](#model-GsaCreateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92432,7 +67953,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterValue](#model-GsaCreateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaCreateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92460,13 +67981,6 @@ "isOrdered": { "type": "boolean" }, - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDiscreteValuesCreateDiscreteValue" - }, - "nullable": true - }, "name": { "type": "string" }, @@ -92477,6 +67991,38 @@ }, "additionalProperties": false }, + "GsaCreateDynamicRecordLinkGroup": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" + }, + { + "required": [ + "attributePairs" + ], + "type": "object", + "properties": { + "forbidOrphans": { + "type": "boolean" + }, + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" + } + } + } + } + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" + }, "GsaCreateExpression": { "required": [ "name", @@ -92511,7 +68057,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, @@ -92546,7 +68092,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, @@ -92566,7 +68112,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaCreateFloatFunctionalAttributeParameter](#model-GsaCreateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaCreateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -92595,7 +68141,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaCreateFloatFunctionalAttributeParameter](#model-GsaCreateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaCreateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -92614,7 +68160,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateFloatFunctionalAttributeDiscreteParameter](#model-GsaCreateFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaCreateFloatFunctionalAttributeNumericParameter](#model-GsaCreateFloatFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateFloatFunctionalAttributeDiscreteParameter\r\n * GsaCreateFloatFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -92655,7 +68201,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -92679,7 +68225,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -92740,13 +68286,6 @@ "description": "If there are no ApplicableApplications, the layout is applicable in all applications.", "nullable": true }, - "sections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateLayoutSection" - }, - "nullable": true - }, "name": { "type": "string" }, @@ -92764,13 +68303,6 @@ ], "type": "object", "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNewLayoutItem" - }, - "nullable": true - }, "name": { "type": "string" }, @@ -92780,7 +68312,7 @@ } }, "additionalProperties": false, - "description": "Create dto for Layout Sections" + "description": "Create dto for Layout Sections\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" }, "GsaCreateLinkedAttributeTabularColumn": { "type": "object", @@ -92801,7 +68333,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", "x-discriminator-value": "linkedAttribute", "x-discriminator-name": "columnType" }, @@ -92824,7 +68356,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", "x-discriminator-value": "linkedColumn", "x-discriminator-name": "columnType" }, @@ -92839,7 +68371,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", "x-discriminator-value": "linkedRecord", "x-discriminator-name": "columnType" }, @@ -92889,7 +68421,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", "x-discriminator-value": "localDateTime", "x-discriminator-name": "columnType" }, @@ -92915,7 +68447,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", "x-discriminator-value": "localDiscrete", "x-discriminator-name": "columnType" }, @@ -92935,7 +68467,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", "x-discriminator-value": "localFile", "x-discriminator-name": "columnType" }, @@ -92955,7 +68487,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", "x-discriminator-value": "localHyperlink", "x-discriminator-name": "columnType" }, @@ -92975,7 +68507,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", "x-discriminator-value": "localInteger", "x-discriminator-name": "columnType" }, @@ -92995,7 +68527,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", "x-discriminator-value": "localLogical", "x-discriminator-name": "columnType" }, @@ -93015,7 +68547,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", "x-discriminator-value": "localLongText", "x-discriminator-name": "columnType" }, @@ -93035,7 +68567,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", "x-discriminator-value": "localPicture", "x-discriminator-name": "columnType" }, @@ -93058,7 +68590,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", "x-discriminator-value": "localPoint", "x-discriminator-name": "columnType" }, @@ -93081,7 +68613,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", "x-discriminator-value": "localRange", "x-discriminator-name": "columnType" }, @@ -93101,7 +68633,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateTabularColumn](#model-GsaCreateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "description": "\r\n\r\nThis extends: GsaCreateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", "x-discriminator-value": "localShortText", "x-discriminator-name": "columnType" }, @@ -93116,7 +68648,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -93131,7 +68663,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -93212,7 +68744,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -93241,8 +68773,7 @@ "type": "array", "items": { "$ref": "#/components/schemas/GsaCreateNumericParameterValue" - }, - "description": "Numeric parameter values cannot be ordered - they are ordered by numeric value." + } }, "interpolationType": { "$ref": "#/components/schemas/GsaParameterInterpolationType" @@ -93254,7 +68785,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameter](#model-GsaCreateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaCreateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -93279,7 +68810,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterContent](#model-GsaCreateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaCreateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -93307,7 +68838,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateParameterValue](#model-GsaCreateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaCreateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -93322,6 +68853,10 @@ "type": { "$ref": "#/components/schemas/GsaParameterType" }, + "helpPath": { + "type": "string", + "nullable": true + }, "defaultParameterValueIndex": { "type": "integer", "format": "int32" @@ -93335,7 +68870,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameter](#model-GsaCreateDiscreteParameter)\r\n * [GsaCreateNumericParameter](#model-GsaCreateNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameter\r\n * GsaCreateNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -93359,7 +68894,7 @@ } }, "additionalProperties": false, - "description": "Set the range and/or default value for parameters used by the attribute.\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameterContent](#model-GsaCreateDiscreteParameterContent)\r\n * [GsaCreateNumericParameterContent](#model-GsaCreateNumericParameterContent)", + "description": "Set the range and/or default value for parameters used by the attribute.\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameterContent\r\n * GsaCreateNumericParameterContent", "discriminator": { "propertyName": "type", "mapping": { @@ -93383,7 +68918,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateDiscreteParameterValue](#model-GsaCreateDiscreteParameterValue)\r\n * [GsaCreateNumericParameterValue](#model-GsaCreateNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateDiscreteParameterValue\r\n * GsaCreateNumericParameterValue", "discriminator": { "propertyName": "type", "mapping": { @@ -93392,64 +68927,6 @@ } } }, - "GsaCreatePermission": { - "required": [ - "name", - "role" - ], - "type": "object", - "properties": { - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreatePermissionCategory": { - "required": [ - "name", - "permissions" - ], - "type": "object", - "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreatePermission" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaCreatePictureAttribute": { "type": "object", "allOf": [ @@ -93461,7 +68938,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -93494,7 +68971,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -93558,111 +69035,6 @@ }, "additionalProperties": false }, - "GsaCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - { - "required": [ - "itemType" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaNewLayoutItemType" - } - }, - "discriminator": { - "propertyName": "itemType", - "mapping": { - "attribute": "#/components/schemas/GsaAttributeCreatePutLayoutItem", - "recordLink": "#/components/schemas/GsaRecordLinkCreatePutLayoutItem", - "smartLink": "#/components/schemas/GsaSmartLinkCreatePutLayoutItem", - "crossDatabaseLink": "#/components/schemas/GsaCrossDatabaseLinkCreatePutLayoutItem", - "associationChain": "#/components/schemas/GsaAssociationChainCreatePutLayoutItem" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutLayoutItem](#model-GsaPutLayoutItem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'\r\n\r\nThis is one of: \r\n * [GsaAttributeCreatePutLayoutItem](#model-GsaAttributeCreatePutLayoutItem)\r\n * [GsaRecordLinkCreatePutLayoutItem](#model-GsaRecordLinkCreatePutLayoutItem)\r\n * [GsaSmartLinkCreatePutLayoutItem](#model-GsaSmartLinkCreatePutLayoutItem)\r\n * [GsaCrossDatabaseLinkCreatePutLayoutItem](#model-GsaCrossDatabaseLinkCreatePutLayoutItem)\r\n * [GsaAssociationChainCreatePutLayoutItem](#model-GsaAssociationChainCreatePutLayoutItem)", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreatePutPermission": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermission" - }, - { - "required": [ - "name", - "role" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutPermission](#model-GsaPutPermission)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, - "GsaCreatePutPermissionCategory": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - { - "required": [ - "name", - "permissions" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreatePermission" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutPermissionCategory](#model-GsaPutPermissionCategory)\r\n\r\nThe value of discriminator property ('type') must be equal to 'create'", - "x-discriminator-value": "create", - "x-discriminator-name": "type" - }, "GsaCreateRangeAttribute": { "type": "object", "allOf": [ @@ -93682,7 +69054,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -93718,6 +69090,7 @@ }, "GsaCreateRecordLinkGroup": { "required": [ + "linkTarget", "name", "reverseName", "type" @@ -93727,6 +69100,9 @@ "type": { "$ref": "#/components/schemas/GsaRecordLinkGroupType" }, + "linkTarget": { + "$ref": "#/components/schemas/GsaLinkTarget" + }, "reverseName": { "type": "string" }, @@ -93739,12 +69115,12 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreateStaticRecordLinkGroup](#model-GsaCreateStaticRecordLinkGroup)\r\n * [GsaCreateSmartRecordLinkGroup](#model-GsaCreateSmartRecordLinkGroup)\r\n * [GsaCreateCrossDatabaseRecordLinkGroup](#model-GsaCreateCrossDatabaseRecordLinkGroup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreateStaticRecordLinkGroup\r\n * GsaCreateDynamicRecordLinkGroup\r\n * GsaCreateCrossDatabaseRecordLinkGroup", "discriminator": { "propertyName": "type", "mapping": { "static": "#/components/schemas/GsaCreateStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaCreateSmartRecordLinkGroup", + "dynamic": "#/components/schemas/GsaCreateDynamicRecordLinkGroup", "crossDatabase": "#/components/schemas/GsaCreateCrossDatabaseRecordLinkGroup" } } @@ -93821,6 +69197,19 @@ }, "additionalProperties": false }, + "GsaCreateSearchRequest": { + "type": "object", + "properties": { + "searchConfig": { + "type": "string", + "nullable": true + }, + "detail": { + "$ref": "#/components/schemas/GsaSearchDetail" + } + }, + "additionalProperties": false + }, "GsaCreateShortTextAttribute": { "type": "object", "allOf": [ @@ -93841,60 +69230,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, - "GsaCreateSmartLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaCreateSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" - }, - { - "required": [ - "attributePairs", - "linkTarget" - ], - "type": "object", - "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateSmartLinkTarget" - }, - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" - }, - "description": "There must be at least one and not more than three attribute pairs." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, "GsaCreateStandardName": { "required": [ "name" @@ -93939,19 +69278,6 @@ }, "additionalProperties": false }, - "GsaCreateStaticLinkTarget": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaCreateStaticRecordLinkGroup": { "type": "object", "allOf": [ @@ -93959,14 +69285,8 @@ "$ref": "#/components/schemas/GsaCreateRecordLinkGroup" }, { - "required": [ - "linkTarget" - ], "type": "object", "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaCreateStaticLinkTarget" - }, "includeIndirectLinks": { "type": "boolean" } @@ -93974,7 +69294,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateRecordLinkGroup](#model-GsaCreateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "description": "\r\n\r\nThis extends: GsaCreateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", "x-discriminator-value": "static", "x-discriminator-name": "type" }, @@ -94009,28 +69329,6 @@ "isHiddenFromSearch": { "type": "boolean" }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -94073,7 +69371,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreateAttribute](#model-GsaCreateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaCreateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -94112,7 +69410,7 @@ } }, "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaCreateLinkedAttributeTabularColumn](#model-GsaCreateLinkedAttributeTabularColumn)\r\n * [GsaCreateLinkedColumnTabularColumn](#model-GsaCreateLinkedColumnTabularColumn)\r\n * [GsaCreateLinkedRecordTabularColumn](#model-GsaCreateLinkedRecordTabularColumn)\r\n * [GsaCreateLocalPointTabularColumn](#model-GsaCreateLocalPointTabularColumn)\r\n * [GsaCreateLocalRangeTabularColumn](#model-GsaCreateLocalRangeTabularColumn)\r\n * [GsaCreateLocalIntegerTabularColumn](#model-GsaCreateLocalIntegerTabularColumn)\r\n * [GsaCreateLocalLogicalTabularColumn](#model-GsaCreateLocalLogicalTabularColumn)\r\n * [GsaCreateLocalShortTextTabularColumn](#model-GsaCreateLocalShortTextTabularColumn)\r\n * [GsaCreateLocalLongTextTabularColumn](#model-GsaCreateLocalLongTextTabularColumn)\r\n * [GsaCreateLocalDateTimeTabularColumn](#model-GsaCreateLocalDateTimeTabularColumn)\r\n * [GsaCreateLocalDiscreteTabularColumn](#model-GsaCreateLocalDiscreteTabularColumn)\r\n * [GsaCreateLocalHyperlinkTabularColumn](#model-GsaCreateLocalHyperlinkTabularColumn)\r\n * [GsaCreateLocalFileTabularColumn](#model-GsaCreateLocalFileTabularColumn)\r\n * [GsaCreateLocalPictureTabularColumn](#model-GsaCreateLocalPictureTabularColumn)", + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaCreateLinkedAttributeTabularColumn\r\n * GsaCreateLinkedColumnTabularColumn\r\n * GsaCreateLinkedRecordTabularColumn\r\n * GsaCreateLocalPointTabularColumn\r\n * GsaCreateLocalRangeTabularColumn\r\n * GsaCreateLocalIntegerTabularColumn\r\n * GsaCreateLocalLogicalTabularColumn\r\n * GsaCreateLocalShortTextTabularColumn\r\n * GsaCreateLocalLongTextTabularColumn\r\n * GsaCreateLocalDateTimeTabularColumn\r\n * GsaCreateLocalDiscreteTabularColumn\r\n * GsaCreateLocalHyperlinkTabularColumn\r\n * GsaCreateLocalFileTabularColumn\r\n * GsaCreateLocalPictureTabularColumn", "discriminator": { "propertyName": "columnType", "mapping": { @@ -94157,36 +69455,12 @@ }, "additionalProperties": false }, - "GsaCreateUnitMapping": { - "required": [ - "equivalentUnit", - "unit" - ], - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "equivalentUnit": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false - }, "GsaCreateUnitSystem": { "required": [ "name" ], "type": "object", "properties": { - "unitMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateUnitMapping" - }, - "description": "Unit mappings will default to each unit being mapped to itself but optionally one or more non-default mappings can be specified here.", - "nullable": true - }, "name": { "type": "string" }, @@ -94196,7 +69470,7 @@ } }, "additionalProperties": false, - "description": "Create dto for Unit Systems" + "description": "Create dto for Unit Systems\r\nNo extra properties compared to CreateSlimNamedEntity yet, but exists for consistency with other 'create dto' types" }, "GsaCreatedByUserProperty": { "type": "object", @@ -94215,7 +69489,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdByUser'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdByUser'", "x-discriminator-value": "createdByUser", "x-discriminator-name": "propertyName" }, @@ -94236,7 +69510,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdDate'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'createdDate'", "x-discriminator-value": "createdDate", "x-discriminator-name": "propertyName" }, @@ -94251,7 +69525,7 @@ } }, "additionalProperties": false, - "description": "The criterion to be used in a search.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\", \"all\", or \"none\" of the criterion.\r\nThese criterion can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * [GsaBooleanCriterion](#model-GsaBooleanCriterion)\r\n * [GsaFreeTextCriterion](#model-GsaFreeTextCriterion)\r\n * [GsaFreeTextPrefixCriterion](#model-GsaFreeTextPrefixCriterion)\r\n * [GsaRecordListMemberCriterion](#model-GsaRecordListMemberCriterion)\r\n * [GsaRecordPropertyCriterion](#model-GsaRecordPropertyCriterion)\r\n * [GsaRecordReferenceCriterion](#model-GsaRecordReferenceCriterion)\r\n * [GsaRecordAncestorCriterion](#model-GsaRecordAncestorCriterion)\r\n * [GsaRecordAncestorHistoryCriterion](#model-GsaRecordAncestorHistoryCriterion)\r\n * [GsaRecordSubsetCriterion](#model-GsaRecordSubsetCriterion)\r\n * [GsaTabularLinkingValueCriterion](#model-GsaTabularLinkingValueCriterion)\r\n * [GsaAttributeCriterion](#model-GsaAttributeCriterion)\r\n * [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n * [GsaNamedCriterion](#model-GsaNamedCriterion)", + "description": "The criterion to be used in a search.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\", \"all\", or \"none\" of the criterion.\r\nThese criterion can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * GsaBooleanCriterion\r\n * GsaFreeTextCriterion\r\n * GsaFreeTextPrefixCriterion\r\n * GsaRecordListMemberCriterion\r\n * GsaRecordPropertyCriterion\r\n * GsaRecordReferenceCriterion\r\n * GsaRecordAncestorCriterion\r\n * GsaRecordAncestorHistoryCriterion\r\n * GsaRecordSubsetCriterion\r\n * GsaTabularLinkingValueCriterion\r\n * GsaAttributeCriterion\r\n * GsaLocalColumnCriterion\r\n * GsaNamedCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -94289,84 +69563,6 @@ ], "type": "string" }, - "GsaCrossDatabaseLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "includeIndirectLinks" - ], - "type": "object", - "properties": { - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabaseLink'", - "x-discriminator-value": "crossDatabaseLink", - "x-discriminator-name": "type" - }, - "GsaCrossDatabaseLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "linkGroupGuid", - "sourceDatabaseGuid", - "sourceTableGuid" - ], - "type": "object", - "properties": { - "sourceDatabaseGuid": { - "type": "string", - "format": "uuid" - }, - "sourceTableGuid": { - "type": "string", - "format": "uuid" - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", - "x-discriminator-value": "crossDatabaseLink", - "x-discriminator-name": "itemType" - }, - "GsaCrossDatabaseRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkBase" - }, - { - "type": "object", - "properties": { - "reverseNotes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkBase](#model-GsaRecordLinkBase)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "recordLinkGroupType" - }, "GsaCrossDatabaseRecordLinkGroup": { "type": "object", "allOf": [ @@ -94386,120 +69582,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", "x-discriminator-value": "crossDatabase", "x-discriminator-name": "type" }, - "GsaCrossDatabaseRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" - }, - { - "required": [ - "linkedDatabaseKey" - ], - "type": "object", - "properties": { - "linkedDatabaseKey": { - "type": "string" - }, - "notes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'crossDatabase'", - "x-discriminator-value": "crossDatabase", - "x-discriminator-name": "recordLinkGroupType" - }, - "GsaCurrenciesInfo": { - "required": [ - "currencies" - ], - "type": "object", - "properties": { - "currencies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCurrency" - } - } - }, - "additionalProperties": false - }, - "GsaCurrency": { - "required": [ - "code", - "factor", - "name" - ], - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The code of the currency." - }, - "name": { - "type": "string", - "description": "The unique name of the currency." - }, - "factor": { - "type": "number", - "description": "The conversion factor of the currency.", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaCurrencyErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaCurrencyErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNameMissingCurrencyErrorDetail](#model-GsaNameMissingCurrencyErrorDetail)\r\n * [GsaDuplicateNameCurrencyErrorDetail](#model-GsaDuplicateNameCurrencyErrorDetail)\r\n * [GsaNameWhitespaceCurrencyErrorDetail](#model-GsaNameWhitespaceCurrencyErrorDetail)\r\n * [GsaCodeMissingCurrencyErrorDetail](#model-GsaCodeMissingCurrencyErrorDetail)\r\n * [GsaDuplicateCodeCurrencyErrorDetail](#model-GsaDuplicateCodeCurrencyErrorDetail)\r\n * [GsaCodeWhitespaceCurrencyErrorDetail](#model-GsaCodeWhitespaceCurrencyErrorDetail)\r\n * [GsaTooLongCodeCurrencyErrorDetail](#model-GsaTooLongCodeCurrencyErrorDetail)\r\n * [GsaInvalidExchangeRateCurrencyErrorDetail](#model-GsaInvalidExchangeRateCurrencyErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "nameMissing": "#/components/schemas/GsaNameMissingCurrencyErrorDetail", - "duplicateName": "#/components/schemas/GsaDuplicateNameCurrencyErrorDetail", - "nameWhitespace": "#/components/schemas/GsaNameWhitespaceCurrencyErrorDetail", - "codeMissing": "#/components/schemas/GsaCodeMissingCurrencyErrorDetail", - "duplicateCode": "#/components/schemas/GsaDuplicateCodeCurrencyErrorDetail", - "codeWhitespace": "#/components/schemas/GsaCodeWhitespaceCurrencyErrorDetail", - "tooLongCode": "#/components/schemas/GsaTooLongCodeCurrencyErrorDetail", - "invalidExchangeRate": "#/components/schemas/GsaInvalidExchangeRateCurrencyErrorDetail" - } - } - }, - "GsaCurrencyErrorReason": { - "enum": [ - "nameMissing", - "duplicateName", - "nameWhitespace", - "codeMissing", - "duplicateCode", - "codeWhitespace", - "tooLongCode", - "invalidExchangeRate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • nameMissing: The currency must have a name.
    • \r\n
  • duplicateName: The currency name is already in use.
    • \r\n
  • nameWhitespace: Currency name must not contain leading or trailing whitespace.
    • \r\n
  • codeMissing: The currency must have a code.
    • \r\n
  • duplicateCode: The currency code is already in use.
    • \r\n
  • codeWhitespace: Currency code must not contain leading or trailing whitespace.
    • \r\n
  • tooLongCode: Currency code cannot be longer than 3 characters.
    • \r\n
  • invalidExchangeRate: Currency conversion factor must be greater than zero.
    • \r\n
\r\n" - }, "GsaCurrentUser": { "type": "object", "properties": { @@ -94554,7 +69640,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * [GsaDataExportBooleanDatum](#model-GsaDataExportBooleanDatum)\r\n * [GsaDataExportDateTimeDatum](#model-GsaDataExportDateTimeDatum)\r\n * [GsaDataExportDiscreteDatum](#model-GsaDataExportDiscreteDatum)\r\n * [GsaDataExportFileDatum](#model-GsaDataExportFileDatum)\r\n * [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n * [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n * [GsaDataExportHyperlinkDatum](#model-GsaDataExportHyperlinkDatum)\r\n * [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n * [GsaDataExportLongTextDatum](#model-GsaDataExportLongTextDatum)\r\n * [GsaDataExportNumericDatum](#model-GsaDataExportNumericDatum)\r\n * [GsaDataExportPictureDatum](#model-GsaDataExportPictureDatum)\r\n * [GsaDataExportPointDatum](#model-GsaDataExportPointDatum)\r\n * [GsaDataExportRangeDatum](#model-GsaDataExportRangeDatum)\r\n * [GsaDataExportShortTextDatum](#model-GsaDataExportShortTextDatum)", + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'applicable'\r\n\r\nThis is one of: \r\n * GsaDataExportBooleanDatum\r\n * GsaDataExportDateTimeDatum\r\n * GsaDataExportDiscreteDatum\r\n * GsaDataExportFileDatum\r\n * GsaDataExportFloatFunctionalDatum\r\n * GsaDataExportDiscreteFunctionalDatum\r\n * GsaDataExportHyperlinkDatum\r\n * GsaDataExportLinkDatum\r\n * GsaDataExportLongTextDatum\r\n * GsaDataExportNumericDatum\r\n * GsaDataExportPictureDatum\r\n * GsaDataExportPointDatum\r\n * GsaDataExportRangeDatum\r\n * GsaDataExportShortTextDatum", "x-discriminator-value": "applicable", "x-discriminator-name": "notApplicable" }, @@ -94597,7 +69683,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "datumType" }, @@ -94618,7 +69704,7 @@ } ], "additionalProperties": false, - "description": "A count of the number of populated values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'countRollup'", + "description": "A count of the number of populated values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'countRollup'", "x-discriminator-value": "countRollup", "x-discriminator-name": "type" }, @@ -94639,7 +69725,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "datumType" }, @@ -94671,7 +69757,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDataExportNotApplicableDatum](#model-GsaDataExportNotApplicableDatum)\r\n * [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n * [GsaDataExportUnknownDatum](#model-GsaDataExportUnknownDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDataExportNotApplicableDatum\r\n * GsaDataExportApplicableDatum\r\n * GsaDataExportUnknownDatum", "discriminator": { "propertyName": "notApplicable", "mapping": { @@ -94701,7 +69787,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "datumType" }, @@ -94742,7 +69828,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * [GsaDataExportDiscreteFunctionalGridDatum](#model-GsaDataExportDiscreteFunctionalGridDatum)\r\n * [GsaDataExportDiscreteFunctionalSeriesDatum](#model-GsaDataExportDiscreteFunctionalSeriesDatum)", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * GsaDataExportDiscreteFunctionalGridDatum\r\n * GsaDataExportDiscreteFunctionalSeriesDatum", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "datumType" }, @@ -94766,7 +69852,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "description": "\r\n\r\nThis extends: GsaDataExportDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", "x-discriminator-value": "grid", "x-discriminator-name": "graphType" }, @@ -94790,7 +69876,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDiscreteFunctionalDatum](#model-GsaDataExportDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "description": "\r\n\r\nThis extends: GsaDataExportDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -94869,7 +69955,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "datumType" }, @@ -94923,7 +70009,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * [GsaDataExportFunctionalGridDatum](#model-GsaDataExportFunctionalGridDatum)\r\n * [GsaDataExportFunctionalSeriesDatum](#model-GsaDataExportFunctionalSeriesDatum)", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * GsaDataExportFunctionalGridDatum\r\n * GsaDataExportFunctionalSeriesDatum", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "datumType" }, @@ -94950,7 +70036,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "description": "\r\n\r\nThis extends: GsaDataExportFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", "x-discriminator-value": "grid", "x-discriminator-name": "graphType" }, @@ -94977,7 +70063,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportFloatFunctionalDatum](#model-GsaDataExportFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "description": "\r\n\r\nThis extends: GsaDataExportFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -95054,7 +70140,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "datumType" }, @@ -95085,7 +70171,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'\r\n\r\nThis is one of: \r\n * [GsaDataExportLinkedRecordsDatum](#model-GsaDataExportLinkedRecordsDatum)\r\n * [GsaDataExportTabularDatum](#model-GsaDataExportTabularDatum)", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'\r\n\r\nThis is one of: \r\n * GsaDataExportLinkedRecordsDatum\r\n * GsaDataExportTabularDatum", "x-discriminator-value": "link", "x-discriminator-name": "datumType" }, @@ -95148,7 +70234,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'linkGroup'", + "description": "\r\n\r\nThis extends: GsaDataExportLinkDatum\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'linkGroup'", "x-discriminator-value": "linkGroup", "x-discriminator-name": "linkDatumType" }, @@ -95169,7 +70255,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "datumType" }, @@ -95192,7 +70278,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", "x-discriminator-value": "notApplicable", "x-discriminator-name": "notApplicable" }, @@ -95213,7 +70299,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "datumType" }, @@ -95238,7 +70324,7 @@ } ], "additionalProperties": false, - "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'statisticalRollup'", + "description": "A statistical rollup of a set of numeric values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'statisticalRollup'", "x-discriminator-value": "statisticalRollup", "x-discriminator-name": "type" }, @@ -95275,7 +70361,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "datumType" }, @@ -95323,18 +70409,28 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "datumType" }, "GsaDataExportRange": { "type": "object", "properties": { - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "highValue": { + "type": "number", + "format": "double", + "nullable": true }, - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "lowValue": { + "type": "number", + "format": "double", + "nullable": true + }, + "highValueIsInclusive": { + "type": "boolean" + }, + "lowValueIsInclusive": { + "type": "boolean" } }, "additionalProperties": false @@ -95362,7 +70458,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "datumType" }, @@ -95479,7 +70575,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDataExportNumericRollupDatum](#model-GsaDataExportNumericRollupDatum)\r\n * [GsaDataExportValueRollupDatum](#model-GsaDataExportValueRollupDatum)\r\n * [GsaDataExportValuesRollupDatum](#model-GsaDataExportValuesRollupDatum)\r\n * [GsaDataExportCountRollupDatum](#model-GsaDataExportCountRollupDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDataExportNumericRollupDatum\r\n * GsaDataExportValueRollupDatum\r\n * GsaDataExportValuesRollupDatum\r\n * GsaDataExportCountRollupDatum", "discriminator": { "propertyName": "type", "mapping": { @@ -95558,7 +70654,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportApplicableDatum](#model-GsaDataExportApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaDataExportApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "datumType" }, @@ -95593,7 +70689,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportLinkDatum](#model-GsaDataExportLinkDatum)\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'tabular'", + "description": "\r\n\r\nThis extends: GsaDataExportLinkDatum\r\n\r\nThe value of discriminator property ('linkDatumType') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "linkDatumType" }, @@ -95664,7 +70760,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataExportDatum](#model-GsaDataExportDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'unknown'", + "description": "\r\n\r\nThis extends: GsaDataExportDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'unknown'", "x-discriminator-value": "unknown", "x-discriminator-name": "notApplicable" }, @@ -95685,7 +70781,7 @@ } ], "additionalProperties": false, - "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'valueRollup'", + "description": "A rollup where the value is a single object (such as a discrete value)\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'valueRollup'", "x-discriminator-value": "valueRollup", "x-discriminator-name": "type" }, @@ -95713,7 +70809,7 @@ } ], "additionalProperties": false, - "description": "A rollup to a list of values\r\n\r\nThis extends: [GsaDataExportRollupDatum](#model-GsaDataExportRollupDatum)\r\n\r\nThe value of discriminator property ('type') must be equal to 'valuesRollup'", + "description": "A rollup to a list of values\r\n\r\nThis extends: GsaDataExportRollupDatum\r\n\r\nThe value of discriminator property ('type') must be equal to 'valuesRollup'", "x-discriminator-value": "valuesRollup", "x-discriminator-name": "type" }, @@ -95732,7 +70828,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUsageDataModificationErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -95791,337 +70887,6 @@ }, "additionalProperties": false }, - "GsaDataSource": { - "type": "object", - "properties": { - "value": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDataUpdate": { - "required": [ - "header", - "token" - ], - "type": "object", - "properties": { - "token": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - }, - "header": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - }, - "runInfo": { - "$ref": "#/components/schemas/GsaDataUpdateRunInfo" - } - }, - "additionalProperties": false - }, - "GsaDataUpdateHeader": { - "required": [ - "containsFallbackIdentifiers", - "createDate", - "name", - "projectGuid", - "sourceVolumeGuid", - "supportedObjectsVersion", - "updateFormatVersion", - "updateGuid" - ], - "type": "object", - "properties": { - "createDate": { - "type": "string", - "description": "The date and time that the update was created.", - "format": "date-time" - }, - "updateGuid": { - "type": "string", - "description": "A unique identity to disambiguate this update from all other updates.", - "format": "uuid" - }, - "prerequisiteUpdateGuid": { - "type": "string", - "description": "GUID for the previous update that need to have been applied before this update can be applied.", - "format": "uuid", - "nullable": true - }, - "prerequisiteUpdateName": { - "type": "string", - "description": "Name of the previous update that need to have been applied before this update can be applied. This is used only for display purposes.", - "nullable": true - }, - "miVersion": { - "type": "string", - "description": "Gets the version of MI that was used to create this update.", - "nullable": true - }, - "supportedObjectsVersion": { - "type": "integer", - "description": "Gets or sets the version number indicating the kinds of object that this update supports. A client will be\r\nable to process updates with an unrecognised SupportedObjectsVersion (although in doing so it will have to\r\nignore fields describing objects it does not recognise).", - "format": "int32" - }, - "updateFormatVersion": { - "type": "integer", - "description": "Gets or sets the version number of the format of the update. This will change if the meaning of any of the\r\nfields in the update changes. A client must not process an update with an UpdateFormatVersion field that it\r\ndoes not recognise, as it cannot be sure of the meaning of the fields it reads.", - "format": "int32" - }, - "sourceDatabaseKey": { - "type": "string", - "description": "Gets or sets the database key of the database from which this update was generated.", - "nullable": true - }, - "sourceVolumeGuid": { - "type": "string", - "description": "Gets or sets the guid of the volume from which the update was generated.", - "format": "uuid" - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the update." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the update.", - "nullable": true - }, - "projectName": { - "type": "string", - "description": "Gets or sets the name of the project this update was created for.", - "nullable": true - }, - "projectGuid": { - "type": "string", - "description": "Gets or sets the guid of the project this update was created for.", - "format": "uuid" - }, - "containsFallbackIdentifiers": { - "type": "boolean", - "description": "Gets or sets the flag informing whether or not this update contains fallback identifiers (mostly names)." - }, - "newVersionGuid": { - "type": "string", - "description": "Gets or sets the value Database Version GUID should be updated to.\r\nIf this field is set then we propose to retarget tabular attributes to link to new version of the database.", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDataUpdateRunInfo": { - "required": [ - "applyAddsAsState", - "databaseKey", - "matchMode", - "retargetTabularAttributes", - "status" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "matchMode": { - "$ref": "#/components/schemas/GsaMatchMode" - }, - "applyAddsAsState": { - "type": "boolean" - }, - "retargetTabularAttributes": { - "type": "boolean" - }, - "status": { - "$ref": "#/components/schemas/GsaUpdateRunStatus" - }, - "progressPercentage": { - "type": "number", - "format": "double", - "nullable": true - }, - "appliedDate": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "errorMessage": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDataUpdateToken": { - "required": [ - "databaseKey", - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "databaseKey": { - "type": "string" - } - }, - "additionalProperties": false - }, - "GsaDataUpdaterJob": { - "required": [ - "databaseKey", - "id", - "jobType", - "status", - "timeStarted" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the token which identifies this job.", - "format": "uuid" - }, - "updateToken": { - "$ref": "#/components/schemas/GsaDataUpdateToken" - }, - "jobType": { - "$ref": "#/components/schemas/GsaDataUpdaterJobType" - }, - "databaseKey": { - "type": "string", - "description": "Gets or sets the key of the database against which this job has been / will be run." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the update.", - "nullable": true - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the job.", - "nullable": true - }, - "status": { - "$ref": "#/components/schemas/GsaDataUpdaterJobStatus" - }, - "projectName": { - "type": "string", - "description": "Gets or sets the project.", - "nullable": true - }, - "timeStarted": { - "type": "string", - "description": "Gets or sets the time that the job started.", - "format": "date-time" - }, - "timeCompleted": { - "type": "string", - "description": "Gets or sets the time that the job completed.", - "format": "date-time", - "nullable": true - }, - "error": { - "type": "string", - "description": "The error that occurred (if any) when the job was run. If the\r\njob has not yet been run, or if the job completed successfully,\r\nthis will be null.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\nupdateToken: Gets or sets the token which links this job to the update on which it is working.\r\n\r\njobType: Gets or sets the type of job.\r\n\r\nstatus: Gets or sets the job status." - }, - "GsaDataUpdaterJobStatus": { - "enum": [ - "Unknown", - "Queued", - "InProgress", - "Completed", - "Cancelled", - "Cancelling", - "Failed", - "NotFound" - ], - "type": "string", - "description": "The status of a data updater job.

Possible values:

\r\n
    \r\n
  • Unknown: This job is in an unknown state.
    • \r\n
  • Queued: This job is in the queue and has not been started.
    • \r\n
  • InProgress: This job is in progress.
    • \r\n
  • Completed: This job completed successfully.
    • \r\n
  • Cancelled: This job was cancelled.
    • \r\n
  • Cancelling: This job is in the process of being cancelled.
    • \r\n
  • Failed: This job failed.
    • \r\n
  • NotFound: This job cannot be found.
    • \r\n
\r\n" - }, - "GsaDataUpdaterJobType": { - "enum": [ - "NoAction", - "CreateUpdate", - "Ship", - "DryRunUpdate", - "ApplyUpdate" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • NoAction: A job that takes no action.
    • \r\n
  • CreateUpdate: A job that creates an update.
    • \r\n
  • Ship: A job that ships an update.
    • \r\n
  • DryRunUpdate: A job that performs a dry run of an update on a database.
    • \r\n
  • ApplyUpdate: A job that applies an update to a database.
    • \r\n
\r\n" - }, - "GsaDataUpdaterProject": { - "required": [ - "guid", - "includeDbDependencies", - "includeDeselectedDbDependencies", - "includeForeignCategoryItems", - "name", - "recordAndAttributeSelectionType" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "recordAndAttributeSelectionType": { - "$ref": "#/components/schemas/GsaRecordAndAttributeSelectionType" - }, - "includeDbDependencies": { - "type": "boolean" - }, - "includeDeselectedDbDependencies": { - "type": "boolean" - }, - "includeForeignCategoryItems": { - "type": "boolean" - }, - "lastUpdateFileName": { - "type": "string", - "nullable": true - }, - "lastMarkedReadyForSendingByUserName": { - "type": "string", - "nullable": true - }, - "timeLastUpdateMarkedReadyForSending": { - "type": "string", - "format": "date-time" - }, - "lastMarkedReadyForSendingAtRevision": { - "type": "integer", - "format": "int32" - }, - "lastUpdateGeneratedByUserName": { - "type": "string", - "nullable": true - }, - "timeLastUpdateGenerated": { - "type": "string", - "format": "date-time" - }, - "profileId": { - "type": "string", - "nullable": true - }, - "selection": { - "$ref": "#/components/schemas/GsaSelection" - } - }, - "additionalProperties": false - }, "GsaDataUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -96141,7 +70906,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'data'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'data'", "x-discriminator-value": "data", "x-discriminator-name": "referencedByType" }, @@ -96150,8 +70915,7 @@ "isLocked", "isReadOnly", "key", - "status", - "userCapabilities" + "status" ], "type": "object", "properties": { @@ -96175,14 +70939,6 @@ "type": "boolean", "nullable": true }, - "isImplicitProfileDisabled": { - "type": "boolean", - "description": "When a database is added to the Granta MI system, it automatically has a standalone database Profile known as an implicit Profile.\r\nThe implicit Profile for this database can be disabled by setting this flag.", - "nullable": true - }, - "defaultTable": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, "key": { "type": "string" }, @@ -96225,45 +70981,6 @@ "schemaVersion": { "type": "string", "nullable": true - }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaDatabaseUserCapabilities" - }, - "configurationDetails": { - "$ref": "#/components/schemas/GsaConfigurationDetails" - }, - "issues": { - "$ref": "#/components/schemas/GsaDatabaseIssues" - } - }, - "additionalProperties": false - }, - "GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'databaseCurrencyUnit'", - "x-discriminator-value": "databaseCurrencyUnit", - "x-discriminator-name": "referencedByType" - }, - "GsaDatabaseIssues": { - "required": [ - "databaseRevisionIdentityHasDecreased" - ], - "type": "object", - "properties": { - "databaseRevisionIdentityHasDecreased": { - "type": "boolean" - }, - "loadingExceptionInfo": { - "$ref": "#/components/schemas/GsaExceptionInformation" } }, "additionalProperties": false @@ -96285,58 +71002,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'databaseKey'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'databaseKey'", "x-discriminator-value": "databaseKey", "x-discriminator-name": "propertyName" }, - "GsaDatabaseSecurityGroups": { - "required": [ - "adminGroup", - "databaseKey", - "grantGroup", - "powerUserGroup", - "readGroup", - "writeGroup" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "adminGroup": { - "type": "string" - }, - "grantGroup": { - "type": "string" - }, - "powerUserGroup": { - "type": "string" - }, - "writeGroup": { - "type": "string" - }, - "readGroup": { - "type": "string" - } - }, - "additionalProperties": false, - "description": "The security groups of a particular database, falling back to global settings for any unfilled groups." - }, - "GsaDatabaseSecurityGroupsInfo": { - "required": [ - "databaseSecurityGroups" - ], - "type": "object", - "properties": { - "databaseSecurityGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDatabaseSecurityGroups" - } - } - }, - "additionalProperties": false - }, "GsaDatabaseStatus": { "enum": [ "Unknown", @@ -96348,11 +71017,10 @@ "FailedToUnload", "Disabled", "SchemaUpgradeRequired", - "SchemaDowngradeRequired", - "Missing" + "SchemaDowngradeRequired" ], "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • Unknown: The current state is unknown.
    • \r\n
  • Ok: The database is working correctly.
    • \r\n
  • Unloaded: The database is not loaded.
    • \r\n
  • Loading: The database is currently being loaded.
    • \r\n
  • Unloading: The database is currently being unloaded.
    • \r\n
  • FailedToLoad: The database failed to be loaded.
    • \r\n
  • FailedToUnload: The database failed to be unloaded.
    • \r\n
  • Disabled: The database is currently disabled.
    • \r\n
  • SchemaUpgradeRequired: The database is at a lower version of the database schema than the current software
    • \r\n
  • SchemaDowngradeRequired: The database is at a higher version of the database schema than the current software
    • \r\n
  • Missing: The database is currently missing.
    • \r\n
\r\n" + "description": "

Possible values:

\r\n
    \r\n
  • Unknown: The current state is unknown.
    • \r\n
  • Ok: The database is working correctly.
    • \r\n
  • Unloaded: The database is not loaded.
    • \r\n
  • Loading: The database is currently being loaded.
    • \r\n
  • Unloading: The database is currently being unloaded.
    • \r\n
  • FailedToLoad: The database failed to be loaded.
    • \r\n
  • FailedToUnload: The database failed to be unloaded.
    • \r\n
  • Disabled: The database is currently disabled.
    • \r\n
  • SchemaUpgradeRequired: The database is at a lower version of the database schema than the current software
    • \r\n
  • SchemaDowngradeRequired: The database is at a higher version of the database schema than the current software
    • \r\n
\r\n" }, "GsaDatabaseStatusInformation": { "type": "object", @@ -96386,24 +71054,6 @@ "additionalProperties": false, "description": "\r\n\r\nstate: Gets the state of this database." }, - "GsaDatabaseUserCapabilities": { - "required": [ - "canRead", - "canWrite" - ], - "type": "object", - "properties": { - "canRead": { - "type": "boolean", - "description": "Specifies whether the current user can read from the database." - }, - "canWrite": { - "type": "boolean", - "description": "Specifies whether the current user can write to the database." - } - }, - "additionalProperties": false - }, "GsaDatabasesInfo": { "type": "object", "properties": { @@ -96440,7 +71090,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "datumType" }, @@ -96455,7 +71105,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a datetime attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "Criterion for aggregating data within a datetime attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, @@ -96470,7 +71120,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, @@ -96494,7 +71144,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "datumType" }, @@ -96523,7 +71173,7 @@ } ], "additionalProperties": false, - "description": "dateTime: Criterion for matching records where the datetime data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "dateTime: Criterion for matching records where the datetime data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, @@ -96538,7 +71188,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, @@ -96566,7 +71216,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed calendar interval.\r\n\r\ninterval: Fixed size of the resulting histogram buckets, in a calendar interval\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedCalendarWidthHistogram'", + "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed calendar interval.\r\n\r\ninterval: Fixed size of the resulting histogram buckets, in a calendar interval\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedCalendarWidthHistogram'", "x-discriminator-value": "dateTimeFixedCalendarWidthHistogram", "x-discriminator-name": "type" }, @@ -96595,7 +71245,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedWidthHistogram'", + "description": "Criterion for aggregating data within a date attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeFixedWidthHistogram'", "x-discriminator-value": "dateTimeFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -96628,7 +71278,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTimeHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'dateTimeHistogram'", "x-discriminator-value": "dateTimeHistogram", "x-discriminator-name": "datumType" }, @@ -96650,7 +71300,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an datetime attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeHistogram'", + "description": "Criterion for aggregating data within an datetime attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTimeHistogram'", "x-discriminator-value": "dateTimeHistogram", "x-discriminator-name": "type" }, @@ -96680,7 +71330,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n * [GsaNotApplicableDatum](#model-GsaNotApplicableDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaApplicableDatum\r\n * GsaNotApplicableDatum", "discriminator": { "propertyName": "notApplicable", "mapping": { @@ -96700,7 +71350,7 @@ } }, "additionalProperties": false, - "description": "Inner criterion of an attribute search criterion. The specific criterion used should match the type of the attribute specified on the outer criterion (Note that there are multiple types that can be used with a discrete attribute, depending on the type of search.)\r\n\r\nThis is one of: \r\n * [GsaDateTimeDatumCriterion](#model-GsaDateTimeDatumCriterion)\r\n * [GsaDiscreteFunctionalRangeDatumCriterion](#model-GsaDiscreteFunctionalRangeDatumCriterion)\r\n * [GsaDiscreteFunctionalValuesDatumCriterion](#model-GsaDiscreteFunctionalValuesDatumCriterion)\r\n * [GsaDiscreteIdentityDatumCriterion](#model-GsaDiscreteIdentityDatumCriterion)\r\n * [GsaDiscreteIdentityValuesDatumCriterion](#model-GsaDiscreteIdentityValuesDatumCriterion)\r\n * [GsaDiscreteGuidDatumCriterion](#model-GsaDiscreteGuidDatumCriterion)\r\n * [GsaDiscreteGuidValuesDatumCriterion](#model-GsaDiscreteGuidValuesDatumCriterion)\r\n * [GsaDiscreteRangeDatumCriterion](#model-GsaDiscreteRangeDatumCriterion)\r\n * [GsaDiscreteTextDatumCriterion](#model-GsaDiscreteTextDatumCriterion)\r\n * [GsaDiscreteTextPrefixDatumCriterion](#model-GsaDiscreteTextPrefixDatumCriterion)\r\n * [GsaDiscreteTextValuesDatumCriterion](#model-GsaDiscreteTextValuesDatumCriterion)\r\n * [GsaFileDatumCriterion](#model-GsaFileDatumCriterion)\r\n * [GsaFilePrefixDatumCriterion](#model-GsaFilePrefixDatumCriterion)\r\n * [GsaFloatFunctionalDatumCriterion](#model-GsaFloatFunctionalDatumCriterion)\r\n * [GsaFloatFunctionalGraphDatumCriterion](#model-GsaFloatFunctionalGraphDatumCriterion)\r\n * [GsaHyperlinkDatumCriterion](#model-GsaHyperlinkDatumCriterion)\r\n * [GsaHyperlinkPrefixDatumCriterion](#model-GsaHyperlinkPrefixDatumCriterion)\r\n * [GsaIntegerDatumCriterion](#model-GsaIntegerDatumCriterion)\r\n * [GsaLinkDatumCriterion](#model-GsaLinkDatumCriterion)\r\n * [GsaLogicalDatumCriterion](#model-GsaLogicalDatumCriterion)\r\n * [GsaLongTextDatumCriterion](#model-GsaLongTextDatumCriterion)\r\n * [GsaLongTextPrefixDatumCriterion](#model-GsaLongTextPrefixDatumCriterion)\r\n * [GsaMathsFunctionalDatumCriterion](#model-GsaMathsFunctionalDatumCriterion)\r\n * [GsaPictureDatumCriterion](#model-GsaPictureDatumCriterion)\r\n * [GsaPointDatumCriterion](#model-GsaPointDatumCriterion)\r\n * [GsaRangeDatumCriterion](#model-GsaRangeDatumCriterion)\r\n * [GsaShortTextDatumCriterion](#model-GsaShortTextDatumCriterion)\r\n * [GsaShortTextPrefixDatumCriterion](#model-GsaShortTextPrefixDatumCriterion)\r\n * [GsaLinkingValueExistsDatumCriterion](#model-GsaLinkingValueExistsDatumCriterion)", + "description": "Inner criterion of an attribute search criterion. The specific criterion used should match the type of the attribute specified on the outer criterion (Note that there are multiple types that can be used with a discrete attribute, depending on the type of search.)\r\n\r\nThis is one of: \r\n * GsaDateTimeDatumCriterion\r\n * GsaDiscreteFunctionalRangeDatumCriterion\r\n * GsaDiscreteFunctionalValuesDatumCriterion\r\n * GsaDiscreteIdentityDatumCriterion\r\n * GsaDiscreteIdentityValuesDatumCriterion\r\n * GsaDiscreteGuidDatumCriterion\r\n * GsaDiscreteGuidValuesDatumCriterion\r\n * GsaDiscreteRangeDatumCriterion\r\n * GsaDiscreteTextDatumCriterion\r\n * GsaDiscreteTextPrefixDatumCriterion\r\n * GsaDiscreteTextValuesDatumCriterion\r\n * GsaFileDatumCriterion\r\n * GsaFilePrefixDatumCriterion\r\n * GsaFloatFunctionalDatumCriterion\r\n * GsaFloatFunctionalGraphDatumCriterion\r\n * GsaHyperlinkDatumCriterion\r\n * GsaHyperlinkPrefixDatumCriterion\r\n * GsaIntegerDatumCriterion\r\n * GsaLinkDatumCriterion\r\n * GsaLogicalDatumCriterion\r\n * GsaLongTextDatumCriterion\r\n * GsaLongTextPrefixDatumCriterion\r\n * GsaMathsFunctionalDatumCriterion\r\n * GsaPictureDatumCriterion\r\n * GsaPointDatumCriterion\r\n * GsaRangeDatumCriterion\r\n * GsaShortTextDatumCriterion\r\n * GsaShortTextPrefixDatumCriterion\r\n * GsaLinkingValueExistsDatumCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -96732,7 +71382,7 @@ "range": "#/components/schemas/GsaRangeDatumCriterion", "shortText": "#/components/schemas/GsaShortTextDatumCriterion", "shortTextPrefix": "#/components/schemas/GsaShortTextPrefixDatumCriterion", - "smartLinkingValue": "#/components/schemas/GsaLinkingValueExistsDatumCriterion" + "dynamicLinkingValue": "#/components/schemas/GsaLinkingValueExistsDatumCriterion" } } }, @@ -96766,7 +71416,7 @@ "range", "shortText", "shortTextPrefix", - "smartLinkingValue" + "dynamicLinkingValue" ], "type": "string" }, @@ -96789,7 +71439,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -96816,7 +71466,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", "x-discriminator-value": "double", "x-discriminator-name": "type" }, @@ -96831,7 +71481,7 @@ } }, "additionalProperties": false, - "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type\r\nFor link datum types, linking information must also be provided.\r\n\r\nThis is one of: \r\n * [GsaIntegerDatumExistsCriterion](#model-GsaIntegerDatumExistsCriterion)\r\n * [GsaPointDatumExistsCriterion](#model-GsaPointDatumExistsCriterion)\r\n * [GsaRangeDatumExistsCriterion](#model-GsaRangeDatumExistsCriterion)\r\n * [GsaLogicalDatumExistsCriterion](#model-GsaLogicalDatumExistsCriterion)\r\n * [GsaShortTextDatumExistsCriterion](#model-GsaShortTextDatumExistsCriterion)\r\n * [GsaLongTextDatumExistsCriterion](#model-GsaLongTextDatumExistsCriterion)\r\n * [GsaDateTimeDatumExistsCriterion](#model-GsaDateTimeDatumExistsCriterion)\r\n * [GsaDiscreteDatumExistsCriterion](#model-GsaDiscreteDatumExistsCriterion)\r\n * [GsaHyperlinkDatumExistsCriterion](#model-GsaHyperlinkDatumExistsCriterion)\r\n * [GsaFileDatumExistsCriterion](#model-GsaFileDatumExistsCriterion)\r\n * [GsaPictureDatumExistsCriterion](#model-GsaPictureDatumExistsCriterion)\r\n * [GsaLinkExistsDatumCriterion](#model-GsaLinkExistsDatumCriterion)\r\n * [GsaFloatFunctionalDatumExistsCriterion](#model-GsaFloatFunctionalDatumExistsCriterion)\r\n * [GsaDiscreteFunctionalDatumExistsCriterion](#model-GsaDiscreteFunctionalDatumExistsCriterion)\r\n * [GsaMathsFunctionalDatumExistsCriterion](#model-GsaMathsFunctionalDatumExistsCriterion)\r\n * [GsaTabularDatumExistsCriterion](#model-GsaTabularDatumExistsCriterion)", + "description": "Inner criterion of an attribute search criterion for when the only bit of information about the datum that we want to convey is its type\r\nFor link datum types, linking information must also be provided.\r\n\r\nThis is one of: \r\n * GsaIntegerDatumExistsCriterion\r\n * GsaPointDatumExistsCriterion\r\n * GsaRangeDatumExistsCriterion\r\n * GsaLogicalDatumExistsCriterion\r\n * GsaShortTextDatumExistsCriterion\r\n * GsaLongTextDatumExistsCriterion\r\n * GsaDateTimeDatumExistsCriterion\r\n * GsaDiscreteDatumExistsCriterion\r\n * GsaHyperlinkDatumExistsCriterion\r\n * GsaFileDatumExistsCriterion\r\n * GsaPictureDatumExistsCriterion\r\n * GsaLinkExistsDatumCriterion\r\n * GsaFloatFunctionalDatumExistsCriterion\r\n * GsaDiscreteFunctionalDatumExistsCriterion\r\n * GsaMathsFunctionalDatumExistsCriterion\r\n * GsaTabularDatumExistsCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -96873,7 +71523,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'datum'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'datum'", "x-discriminator-value": "datum", "x-discriminator-name": "type" }, @@ -96897,7 +71547,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -96923,7 +71573,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumRollup](#model-GsaDatumRollup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'list'", + "description": "\r\n\r\nThis extends: GsaDatumRollup\r\n\r\nThe value of discriminator property ('type') must be equal to 'list'", "x-discriminator-value": "list", "x-discriminator-name": "type" }, @@ -96965,7 +71615,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDatumListRollup](#model-GsaDatumListRollup)\r\n * [GsaDatumIntegerRollup](#model-GsaDatumIntegerRollup)\r\n * [GsaDatumDoubleRollup](#model-GsaDatumDoubleRollup)\r\n * [GsaDatumDiscreteRollup](#model-GsaDatumDiscreteRollup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDatumListRollup\r\n * GsaDatumIntegerRollup\r\n * GsaDatumDoubleRollup\r\n * GsaDatumDiscreteRollup", "discriminator": { "propertyName": "type", "mapping": { @@ -97017,42 +71667,10 @@ } ], "additionalProperties": false, - "description": "Default expression must be from attribute's expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultExpressionNotFound'", + "description": "Default expression must be from attribute's expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultExpressionNotFound'", "x-discriminator-value": "defaultExpressionNotFound", "x-discriminator-name": "reason" }, - "GsaDefaultFallbackSecurityGroups": { - "required": [ - "adminGroup", - "grantGroup", - "powerUserGroup", - "readGroup", - "systemGroup", - "writeGroup" - ], - "type": "object", - "properties": { - "systemGroup": { - "type": "string" - }, - "adminGroup": { - "type": "string" - }, - "grantGroup": { - "type": "string" - }, - "powerUserGroup": { - "type": "string" - }, - "writeGroup": { - "type": "string" - }, - "readGroup": { - "type": "string" - } - }, - "additionalProperties": false - }, "GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail": { "type": "object", "allOf": [ @@ -97064,101 +71682,10 @@ } ], "additionalProperties": false, - "description": "Default free parameter must be from attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultFreeParameterNotFound'", + "description": "Default free parameter must be from attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultFreeParameterNotFound'", "x-discriminator-value": "defaultFreeParameterNotFound", "x-discriminator-name": "reason" }, - "GsaDefaultLayoutGuidErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultLayoutGuid'", - "x-discriminator-value": "defaultLayoutGuid", - "x-discriminator-name": "reason" - }, - "GsaDefaultParameterValueGuidParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "defaultParameterValueGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Default parameter value GUID does not match any parameter value.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueGuid'", - "x-discriminator-value": "defaultParameterValueGuid", - "x-discriminator-name": "reason" - }, - "GsaDefaultParameterValueIndexAndGuidParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Default parameter value can be specified by either index or GUID, not both.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndexAndGuid'", - "x-discriminator-value": "defaultParameterValueIndexAndGuid", - "x-discriminator-name": "reason" - }, - "GsaDefaultParameterValueIndexParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "defaultParameterValueIndex": { - "type": "integer", - "format": "int32" - }, - "numberOfParameterValues": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "Default parameter value index out of range.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndex'", - "x-discriminator-value": "defaultParameterValueIndex", - "x-discriminator-name": "reason" - }, - "GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Default parameter value index can only be used when values are being updated.\r\nUse DefaultParameterValueGuid when values are not being updated.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultParameterValueIndexWithoutValues'", - "x-discriminator-value": "defaultParameterValueIndexWithoutValues", - "x-discriminator-name": "reason" - }, "GsaDefaultParameterValueUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -97173,32 +71700,16 @@ "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" }, - "nullable": true, - "readOnly": true + "nullable": true } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'defaultParameterValue'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'defaultParameterValue'", "x-discriminator-value": "defaultParameterValue", "x-discriminator-name": "referencedByType" }, - "GsaDefaultSubsetGuidErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'defaultSubsetGuid'", - "x-discriminator-value": "defaultSubsetGuid", - "x-discriminator-name": "reason" - }, "GsaDeleteRecordListItem": { "required": [ "databaseGuid", @@ -97238,27 +71749,6 @@ }, "additionalProperties": false }, - "GsaDescriptionLengthFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object", - "properties": { - "maxLengthOfFileDescription": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "The description exceeds the maximum number of allowed characters.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'descriptionLength'", - "x-discriminator-value": "descriptionLength", - "x-discriminator-name": "reason" - }, "GsaDiscreteAttribute": { "type": "object", "allOf": [ @@ -97282,32 +71772,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, - "GsaDiscreteChartData": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaChartData" - }, - { - "type": "object", - "properties": { - "order": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -97333,7 +71798,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "datumType" }, @@ -97348,7 +71813,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -97378,7 +71843,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "type" }, @@ -97398,7 +71863,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaDiscreteFunctionalAttributeParameter](#model-GsaDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -97421,7 +71886,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalAttributeParameter](#model-GsaDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -97440,7 +71905,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteFunctionalAttributeDiscreteParameter](#model-GsaDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaDiscreteFunctionalAttributeNumericParameter](#model-GsaDiscreteFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaDiscreteFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -97482,7 +71947,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * [GsaDiscreteFunctionalSeriesDatum](#model-GsaDiscreteFunctionalSeriesDatum)\r\n * [GsaDiscreteFunctionalGridDatum](#model-GsaDiscreteFunctionalGridDatum)", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteFunctional'\r\n\r\nThis is one of: \r\n * GsaDiscreteFunctionalSeriesDatum\r\n * GsaDiscreteFunctionalGridDatum", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "datumType" }, @@ -97497,7 +71962,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "type" }, @@ -97520,7 +71985,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", "x-discriminator-value": "grid", "x-discriminator-name": "graphType" }, @@ -97557,7 +72022,7 @@ } ], "additionalProperties": false, - "description": "discreteFunctionalRange: Criterion for matching records with discrete functional data where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalRange'", + "description": "discreteFunctionalRange: Criterion for matching records with discrete functional data where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalRange'", "x-discriminator-value": "discreteFunctionalRange", "x-discriminator-name": "type" }, @@ -97580,7 +72045,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDiscreteFunctionalDatum](#model-GsaDiscreteFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "description": "\r\n\r\nThis extends: GsaDiscreteFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -97623,7 +72088,7 @@ } ], "additionalProperties": false, - "description": "discreteFunctionalValues: Criterion for matching records with discrete functional data where the discrete values are one of the given values. Either identities or GUIDs should be provided.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalValues'", + "description": "discreteFunctionalValues: Criterion for matching records with discrete functional data where the discrete values are one of the given values. Either identities or GUIDs should be provided.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctionalValues'", "x-discriminator-value": "discreteFunctionalValues", "x-discriminator-name": "type" }, @@ -97647,7 +72112,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphParameterValue](#model-GsaGraphParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaGraphParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "parameterType" }, @@ -97670,7 +72135,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "graphValueType" }, @@ -97696,7 +72161,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGridGraph](#model-GsaGridGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaGridGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "functionalType" }, @@ -97743,7 +72208,7 @@ } ], "additionalProperties": false, - "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuid'", + "description": "discreteGuid: Criterion for matching records where the GUID of the discrete data matches the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuid'", "x-discriminator-value": "discreteGuid", "x-discriminator-name": "type" }, @@ -97787,7 +72252,7 @@ } ], "additionalProperties": false, - "description": "discreteGuidValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value GUIDs. One or more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuidValues'", + "description": "discreteGuidValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value GUIDs. One or more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteGuidValues'", "x-discriminator-value": "discreteGuidValues", "x-discriminator-name": "type" }, @@ -97811,7 +72276,7 @@ } ], "additionalProperties": false, - "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentity'", + "description": "discreteIdentity: Criterion for matching records where the identity of the discrete data matches the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentity'", "x-discriminator-value": "discreteIdentity", "x-discriminator-name": "type" }, @@ -97855,7 +72320,7 @@ } ], "additionalProperties": false, - "description": "discreteIdentityValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value identities. One or more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentityValues'", + "description": "discreteIdentityValues: Criterion for matching records where the discrete data matches any, all and/or none of the provided discrete value identities. One or more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteIdentityValues'", "x-discriminator-value": "discreteIdentityValues", "x-discriminator-name": "type" }, @@ -97881,7 +72346,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameter](#model-GsaParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -97904,7 +72369,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterContent](#model-GsaParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -97927,7 +72392,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterDataValue](#model-GsaParameterDataValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaParameterDataValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "parameterType" }, @@ -97958,7 +72423,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteName'", + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteName'", "x-discriminator-value": "discreteName", "x-discriminator-name": "type" }, @@ -97981,7 +72446,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterValue](#model-GsaParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -98014,40 +72479,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteValue'", + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteValue'", "x-discriminator-value": "discreteValue", "x-discriminator-name": "type" }, - "GsaDiscreteQualitySystem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - { - "required": [ - "qualityDiscreteValues", - "thresholdValue" - ], - "type": "object", - "properties": { - "thresholdValue": { - "$ref": "#/components/schemas/GsaQualityDiscreteValue" - }, - "qualityDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQualityDiscreteValue" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaQualitySystem](#model-GsaQualitySystem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", - "x-discriminator-value": "discrete", - "x-discriminator-name": "type" - }, "GsaDiscreteRange": { "required": [ "parameterValues" @@ -98088,7 +72523,7 @@ } ], "additionalProperties": false, - "description": "discreteRange: Criterion for matching records for where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteRange'", + "description": "discreteRange: Criterion for matching records for where the discrete values are in the given range. If one of gte or lte is null, this will be an open ended search\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteRange'", "x-discriminator-value": "discreteRange", "x-discriminator-name": "type" }, @@ -98136,7 +72571,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaSeriesGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "functionalType" }, @@ -98181,7 +72616,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteText'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'discreteText'", "x-discriminator-value": "discreteText", "x-discriminator-name": "datumType" }, @@ -98208,7 +72643,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating textual data within a discrete attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", + "description": "Criterion for aggregating textual data within a discrete attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", "x-discriminator-value": "discreteText", "x-discriminator-name": "type" }, @@ -98234,7 +72669,7 @@ } ], "additionalProperties": false, - "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", + "description": "discreteText: Criterion for matching records where the text of the discrete data contains the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteText'", "x-discriminator-value": "discreteText", "x-discriminator-name": "type" }, @@ -98257,7 +72692,7 @@ } ], "additionalProperties": false, - "description": "discreteTextPrefix: Criterion for matching records where the text of the discrete data begins with the specified value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextPrefix'", + "description": "discreteTextPrefix: Criterion for matching records where the text of the discrete data begins with the specified value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextPrefix'", "x-discriminator-value": "discreteTextPrefix", "x-discriminator-name": "type" }, @@ -98298,7 +72733,7 @@ } ], "additionalProperties": false, - "description": "discreteTextValues: Criterion for matching records where the text in the discrete data matches all, any and/or none of the specified text strings. One of more field can be null.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextValues'", + "description": "discreteTextValues: Criterion for matching records where the text in the discrete data matches all, any and/or none of the specified text strings. One of more field can be null.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteTextValues'", "x-discriminator-value": "discreteTextValues", "x-discriminator-name": "type" }, @@ -98307,7 +72742,6 @@ "discreteValues", "guid", "isOrdered", - "isProtected", "name" ], "type": "object", @@ -98321,10 +72755,6 @@ "isOrdered": { "type": "boolean" }, - "isProtected": { - "type": "boolean", - "description": "If true, the discrete type is protected from all changes." - }, "name": { "type": "string" }, @@ -98336,9 +72766,6 @@ "additionalProperties": false }, "GsaDiscreteTypeDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -98346,12 +72773,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -98364,32 +72786,27 @@ "additionalProperties": false }, "GsaDiscreteTypeUsage": { + "required": [ + "attributes", + "tabularColumns" + ], "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimAttribute" - }, - "nullable": true + } }, "tabularColumns": { "type": "array", "items": { "$ref": "#/components/schemas/GsaTabularAttributeWithColumns" - }, - "nullable": true + } } }, "additionalProperties": false }, - "GsaDiscreteTypeUsageType": { - "enum": [ - "attributes", - "tabularColumns" - ], - "type": "string" - }, "GsaDiscreteTypesInfo": { "type": "object", "properties": { @@ -98441,7 +72858,7 @@ "$ref": "#/components/schemas/GsaDiscreteValueAggregateErrorReason" }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -98453,35 +72870,6 @@ }, "additionalProperties": false }, - "GsaDiscreteValueNotInDiscreteTypeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "discreteTypeGuid", - "discreteValueGuid" - ], - "type": "object", - "properties": { - "discreteValueGuid": { - "type": "string", - "format": "uuid" - }, - "discreteTypeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'discreteValueNotInDiscreteType'", - "x-discriminator-value": "discreteValueNotInDiscreteType", - "x-discriminator-name": "reason" - }, "GsaDiscreteValuesCreateDiscreteValue": { "required": [ "name" @@ -98502,15 +72890,10 @@ "GsaDiscreteValuesDiscreteValue": { "required": [ "guid", - "isProtected", "name" ], "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "description": "If true, the discrete value is protected from all changes." - }, "name": { "type": "string" }, @@ -98570,160 +72953,6 @@ "type": "string", "description": "The status of the amount of space remaining on the disk.

Possible values:

\r\n
    \r\n
  • Ok: There is enough space.
    • \r\n
  • LowWatermarkReached: Once the disk reaches this point, Elasticsearch will not allocate any more shards to this node.
    • \r\n
  • HighWatermarkReached: At this point, Elasticsearch will attempt to relocate shards away from this node.
    • \r\n
  • FloodStageReached: At this point, Elastic search will enforce a read only block on the index.
    • \r\n
\r\n" }, - "GsaDisplayNameEmptyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "language": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Display name cannot be empty. Display names are optional and can be set to null to remove, but cannot be an empty string or white space only.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameEmpty'", - "x-discriminator-value": "displayNameEmpty", - "x-discriminator-name": "reason" - }, - "GsaDisplayNameLanguageNotProvidedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Display name must have a language.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameLanguageNotProvided'", - "x-discriminator-value": "displayNameLanguageNotProvided", - "x-discriminator-name": "reason" - }, - "GsaDisplayNameLanguageNotSupportedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "language": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Display name language is not supported. Language must be a .NET culture, e.g. \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\"\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'displayNameLanguageNotSupported'", - "x-discriminator-value": "displayNameLanguageNotSupported", - "x-discriminator-name": "reason" - }, - "GsaDisplayNamesImportErrorDetail": { - "required": [ - "message" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaDisplayNamesImportErrorReason" - }, - "rowIndex": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "fieldValue": { - "type": "string", - "nullable": true - }, - "columnHeader": { - "type": "string", - "nullable": true - }, - "itemType": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDisplayNamesImportErrorReason": { - "enum": [ - "unknown", - "malformedLine", - "incorrectNumberOfColumns", - "invalidSchemaType", - "invalidLanguage", - "schemaItemNotFound", - "emptyColumn", - "extraInfoMissing", - "translationTooLong" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • unknown: An error occurred
    • \r\n
  • malformedLine: Invalid format.
    • \r\n
  • incorrectNumberOfColumns: Incorrect number of columns.
    • \r\n
  • invalidSchemaType: Type is not a supported type for Display Names.
    • \r\n
  • invalidLanguage: Invalid language code.
    • \r\n
  • schemaItemNotFound: Schema item was not found in the database.
    • \r\n
  • emptyColumn: Column must be specified.
    • \r\n
  • extraInfoMissing: Item in column must be specified.
    • \r\n
  • translationTooLong: The Display Name translation is too long.
    • \r\n
\r\n" - }, - "GsaDisplayNamesImportException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDisplayNamesImportErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaDisplayNamesInfo": { - "type": "object", - "properties": { - "displayNames": { - "$ref": "#/components/schemas/GsaGrid" - } - }, - "additionalProperties": false - }, - "GsaDivideByZeroUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'divideByZero'", - "x-discriminator-value": "divideByZero", - "x-discriminator-name": "reason" - }, "GsaDoubleSortingValue": { "type": "object", "allOf": [ @@ -98741,92 +72970,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'double'", "x-discriminator-value": "double", "x-discriminator-name": "type" }, - "GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "required": [ - "duplicateGuids", - "duplicateNames" - ], - "type": "object", - "properties": { - "duplicateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "Duplicate categories were specified, either by name or GUID.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCategories'", - "x-discriminator-value": "duplicateCategories", - "x-discriminator-name": "reason" - }, - "GsaDuplicateCategoryGuidsAccessControlErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - { - "required": [ - "duplicateGuids" - ], - "type": "object", - "properties": { - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "Duplicate permission category GUIDs were specified in the request.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCategoryGuids'", - "x-discriminator-value": "duplicateCategoryGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateCodeCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency with specified code already exists.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateCode'", - "x-discriminator-value": "duplicateCode", - "x-discriminator-name": "reason" - }, "GsaDuplicateDatabaseAddDatabaseValidationIssue": { "type": "object", "allOf": [ @@ -98850,34 +72997,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateDatabase'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateDatabase'", "x-discriminator-value": "duplicateDatabase", "x-discriminator-name": "IssueType" }, - "GsaDuplicateDiscreteValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "discreteValueGuid" - ], - "type": "object", - "properties": { - "discreteValueGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "A discrete value GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateDiscreteValue'", - "x-discriminator-value": "duplicateDiscreteValue", - "x-discriminator-name": "reason" - }, "GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail": { "type": "object", "allOf": [ @@ -98899,7 +73022,7 @@ } ], "additionalProperties": false, - "description": "No duplicate expression GUIDs allowed.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateExpressionGuids'", + "description": "No duplicate expression GUIDs allowed.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateExpressionGuids'", "x-discriminator-value": "duplicateExpressionGuids", "x-discriminator-name": "reason" }, @@ -98925,7 +73048,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateGuid'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateGuid'", "x-discriminator-value": "duplicateGuid", "x-discriminator-name": "IssueType" }, @@ -98940,91 +73063,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateKey'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateKey'", "x-discriminator-value": "duplicateKey", "x-discriminator-name": "IssueType" }, - "GsaDuplicateMappedAttributeGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedAttributeGuids'", - "x-discriminator-value": "duplicateMappedAttributeGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedCrossDatabaseRecordLinkGroupGuids'", - "x-discriminator-value": "duplicateMappedCrossDatabaseRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateMappedParameterGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedParameterGuids'", - "x-discriminator-value": "duplicateMappedParameterGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateMappedRecordLinkGroupGuids'", - "x-discriminator-value": "duplicateMappedRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicateNameCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency with specified name already exists.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateName'", - "x-discriminator-value": "duplicateName", - "x-discriminator-name": "reason" - }, "GsaDuplicateParameterGuidsAttributeErrorDetail": { "type": "object", "allOf": [ @@ -99046,123 +73088,10 @@ } ], "additionalProperties": false, - "description": "No duplicate parameter GUIDs allowed.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateParameterGuids'", + "description": "No duplicate parameter GUIDs allowed.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateParameterGuids'", "x-discriminator-value": "duplicateParameterGuids", "x-discriminator-name": "reason" }, - "GsaDuplicatePermissionGuidsAccessControlErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - { - "required": [ - "categoryGuid", - "duplicateGuids" - ], - "type": "object", - "properties": { - "categoryGuid": { - "type": "string", - "format": "uuid" - }, - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "Duplicate permission GUIDs were specified within a category in the request.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicatePermissionGuids'", - "x-discriminator-value": "duplicatePermissionGuids", - "x-discriminator-name": "reason" - }, - "GsaDuplicatePermissionsPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "required": [ - "duplicateGuids", - "duplicateNames" - ], - "type": "object", - "properties": { - "duplicateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "duplicateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "Duplicate permissions were specified, either by name or GUID.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicatePermissions'", - "x-discriminator-value": "duplicatePermissions", - "x-discriminator-name": "reason" - }, - "GsaDuplicateSymbolUnitErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - { - "required": [ - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateSymbol'", - "x-discriminator-value": "duplicateSymbol", - "x-discriminator-name": "reason" - }, - "GsaDuplicateTableErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "A table GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTable'", - "x-discriminator-value": "duplicateTable", - "x-discriminator-name": "reason" - }, "GsaDuplicateTabularColumnGuidsErrorDetail": { "type": "object", "allOf": [ @@ -99184,7 +73113,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnGuids'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnGuids'", "x-discriminator-value": "duplicateTabularColumnGuids", "x-discriminator-name": "reason" }, @@ -99208,7 +73137,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnNames'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'duplicateTabularColumnNames'", "x-discriminator-value": "duplicateTabularColumnNames", "x-discriminator-name": "reason" }, @@ -99237,53 +73166,81 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateVersionGuid'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'duplicateVersionGuid'", "x-discriminator-value": "duplicateVersionGuid", "x-discriminator-name": "IssueType" }, - "GsaEmptyAxisNameAttributeErrorDetail": { + "GsaDynamicLinkGroupUsageDataModificationErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" + "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" }, { - "type": "object" + "type": "object", + "properties": { + "referencedBy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimNamedEntity" + }, + "nullable": true + } + } } ], "additionalProperties": false, - "description": "Axis name cannot be empty or whitespace.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyAxisName'", - "x-discriminator-value": "emptyAxisName", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'dynamicLinkGroup'", + "x-discriminator-value": "dynamicLinkGroup", + "x-discriminator-name": "referencedByType" }, - "GsaEmptySymbolUnitErrorDetail": { + "GsaDynamicRecordLinkGroup": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "$ref": "#/components/schemas/GsaRecordLinkGroup" }, { - "type": "object" + "required": [ + "attributePairs", + "forbidOrphans", + "referentialIntegrityModel" + ], + "type": "object", + "properties": { + "forbidOrphans": { + "type": "boolean" + }, + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeLinkPair" + } + } + } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptySymbol'", - "x-discriminator-value": "emptySymbol", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" }, - "GsaEmptyTableTypeErrorDetail": { + "GsaEmptyAxisNameAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableTypeErrorDetail](#model-GsaTableTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyTableType'", - "x-discriminator-value": "emptyTableType", + "description": "Axis name cannot be empty or whitespace.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'emptyAxisName'", + "x-discriminator-value": "emptyAxisName", "x-discriminator-name": "reason" }, "GsaEnabledLicensesInfo": { @@ -99353,7 +73310,7 @@ } ], "additionalProperties": false, - "description": "Entity with GUID already exists.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityAlreadyExists'", + "description": "Entity with GUID already exists.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityAlreadyExists'", "x-discriminator-value": "entityAlreadyExists", "x-discriminator-name": "reason" }, @@ -99374,134 +73331,10 @@ } ], "additionalProperties": false, - "description": "GUID has been specified more than once in the request.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityIdentifierAlreadySpecified'", + "description": "GUID has been specified more than once in the request.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'entityIdentifierAlreadySpecified'", "x-discriminator-value": "entityIdentifierAlreadySpecified", "x-discriminator-name": "reason" }, - "GsaEntityType": { - "enum": [ - "attribute", - "database", - "discreteValue", - "discreteType", - "metaAttribute", - "parameter", - "parameterValue", - "table", - "file", - "folder", - "recordHistory", - "recordLinkGroup", - "unit", - "constant", - "permission", - "permissionCategory", - "accessControlCategory" - ], - "type": "string" - }, - "GsaEquationUnitErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'equation'", - "x-discriminator-value": "equation", - "x-discriminator-name": "reason" - }, - "GsaErrorCode": { - "enum": [ - "unknown", - "accessDenied", - "addDatabase", - "attributeCreation", - "dataValidation", - "deleteRecordVersionControl", - "deletion", - "discreteValueAggregate", - "displayNamesImport", - "fileCreation", - "fileMove", - "fileUpdate", - "folderCreation", - "folderDeletion", - "folderMove", - "folderUpdate", - "getModifiableRecordVersionControl", - "imageTypeValidation", - "inputValidation", - "internalServerError", - "jsonSerialization", - "noSuchEntity", - "noSuchItem", - "notImplemented", - "notSpecified", - "notSupported", - "parameterCreation", - "parameterUpdate", - "parameterValueCreation", - "parameterValueUpdate", - "recordHistoryCopy", - "recordHistoryCreate", - "recordHistoryMove", - "recordLinkGroupCreation", - "recordLinkGroupUpdate", - "recordListPublish", - "recordListResetAwaitingApproval", - "recordListSetAwaitingApproval", - "recordListSetPermissions", - "recordListUnpublish", - "releaseRecordVersionControl", - "releaseTableVersionControl", - "subtypeDeserialization", - "serverNotAvailable", - "upgradeDatabase", - "withdrawRecordVersionControl", - "recordNotModifiable", - "conflicting", - "currencyCreation", - "currencyUpdate", - "currencyImport", - "currencyImportDuplicates", - "unitCreation", - "unitUpdate", - "constantCreation", - "constantUpdate", - "standardNameCreation", - "standardNameUpdate", - "standardNameDeletion", - "permissionCreation", - "permissionUpdate", - "permissionDeletion", - "permissionCategoryCreation", - "permissionCategoryUpdate", - "permissionCategoryDeletion", - "permissionCategoryReplace", - "permissionCategoriesAccessControlUpdate", - "accessControlCategoryCreation", - "accessControlCategoryUpdate", - "getUnitEquivalents", - "setUnitEquivalents", - "tableCreation", - "tableUpdate" - ], - "type": "string" - }, "GsaErrorDetail": { "required": [ "message", @@ -99518,51 +73351,6 @@ }, "additionalProperties": false }, - "GsaErrorResponse": { - "type": "object", - "properties": { - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "message": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaExceptionInformation": { - "required": [ - "exceptionTypeFullName", - "localisedMessage", - "message", - "stringifiedException" - ], - "type": "object", - "properties": { - "exceptionTypeFullName": { - "type": "string", - "description": "Full type name of the original exception." - }, - "message": { - "type": "string", - "description": "Message of the original exception." - }, - "localisedMessage": { - "type": "string", - "description": "Localised message of the original exception if available. Regular message of the original exception otherwise." - }, - "stringifiedException": { - "type": "string", - "description": "The result of calling .ToString() on the original exception." - }, - "innerExceptionInfo": { - "$ref": "#/components/schemas/GsaExceptionInformation" - } - }, - "additionalProperties": false, - "description": "\r\n\r\ninnerExceptionInfo: Exception information for the inner exception if available, null otherwise." - }, "GsaExcludeValuesSpecifier": { "type": "object", "allOf": [ @@ -99592,7 +73380,7 @@ } ], "additionalProperties": false, - "description": "Filters based on a list of identities or guids to exclude.\r\nAll other guids or identities will be included.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'exclude'", + "description": "Filters based on a list of identities or guids to exclude.\r\nAll other guids or identities will be included.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'exclude'", "x-discriminator-value": "exclude", "x-discriminator-name": "filterOn" }, @@ -99613,7 +73401,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'existingTabularColumnGuid'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'existingTabularColumnGuid'", "x-discriminator-value": "existingTabularColumnGuid", "x-discriminator-name": "reason" }, @@ -99636,7 +73424,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordExportFailure](#model-GsaRecordExportFailure)\r\n * [GsaLinkExportFailure](#model-GsaLinkExportFailure)\r\n * [GsaAttributeExportFailure](#model-GsaAttributeExportFailure)\r\n * [GsaDatumExportFailure](#model-GsaDatumExportFailure)\r\n * [GsaRollupExportFailure](#model-GsaRollupExportFailure)", + "description": "\r\n\r\nThis is one of: \r\n * GsaRecordExportFailure\r\n * GsaLinkExportFailure\r\n * GsaAttributeExportFailure\r\n * GsaDatumExportFailure\r\n * GsaRollupExportFailure", "discriminator": { "propertyName": "type", "mapping": { @@ -99682,7 +73470,6 @@ "guid", "name", "parameterDependencies", - "table", "value" ], "type": "object", @@ -99711,9 +73498,6 @@ "$ref": "#/components/schemas/GsaSlimNamedEntity" } }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, "name": { "type": "string" }, @@ -99748,7 +73532,7 @@ } ], "additionalProperties": false, - "description": "Expression is invalid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expression'", + "description": "Expression is invalid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expression'", "x-discriminator-value": "expression", "x-discriminator-name": "reason" }, @@ -99764,7 +73548,7 @@ "referencedBy": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimExpression" + "$ref": "#/components/schemas/GsaSlimNamedEntity" }, "nullable": true } @@ -99772,7 +73556,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'expression'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'expression'", "x-discriminator-value": "expression", "x-discriminator-name": "referencedByType" }, @@ -99797,7 +73581,7 @@ } ], "additionalProperties": false, - "description": "Parameter lists lacks some parameters required by the chosen expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expressionsHaveUnknownParameters'", + "description": "Parameter lists lacks some parameters required by the chosen expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'expressionsHaveUnknownParameters'", "x-discriminator-value": "expressionsHaveUnknownParameters", "x-discriminator-name": "reason" }, @@ -99814,31 +73598,6 @@ }, "additionalProperties": false }, - "GsaFileAlreadyExistsFileMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "parentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "A file with same name already exists as a child folder of the new parent.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileAlreadyExists'", - "x-discriminator-value": "fileAlreadyExists", - "x-discriminator-name": "reason" - }, "GsaFileAttribute": { "type": "object", "allOf": [ @@ -99850,37 +73609,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, - "GsaFileCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaFileDatum": { "type": "object", "allOf": [ @@ -99920,7 +73652,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "datumType" }, @@ -99943,7 +73675,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, @@ -99958,50 +73690,10 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, - "GsaFileErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFileErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaConfigInvalidJsonFileErrorDetail](#model-GsaConfigInvalidJsonFileErrorDetail)\r\n * [GsaDescriptionLengthFileErrorDetail](#model-GsaDescriptionLengthFileErrorDetail)\r\n * [GsaFileNameFileErrorDetail](#model-GsaFileNameFileErrorDetail)\r\n * [GsaNamedEntityFileErrorDetail](#model-GsaNamedEntityFileErrorDetail)\r\n * [GsaNoDataFileErrorDetail](#model-GsaNoDataFileErrorDetail)\r\n * [GsaNoFileFileErrorDetail](#model-GsaNoFileFileErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "configInvalidJson": "#/components/schemas/GsaConfigInvalidJsonFileErrorDetail", - "descriptionLength": "#/components/schemas/GsaDescriptionLengthFileErrorDetail", - "fileName": "#/components/schemas/GsaFileNameFileErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityFileErrorDetail", - "noData": "#/components/schemas/GsaNoDataFileErrorDetail", - "noFile": "#/components/schemas/GsaNoFileFileErrorDetail" - } - } - }, - "GsaFileErrorReason": { - "enum": [ - "configInvalidJson", - "descriptionLength", - "fileName", - "namedEntity", - "noData", - "noFile" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • configInvalidJson: Configuration's value must be valid JSON.
    • \r\n
  • descriptionLength: The description exceeds the maximum number of allowed characters.
    • \r\n
  • fileName: The name is not a valid file name.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noData: The File is invalid as it has no data.
    • \r\n
  • noFile: No File found in the Form data.
    • \r\n
\r\n" - }, "GsaFileHeader": { "required": [ "dataLength", @@ -100041,124 +73733,6 @@ }, "additionalProperties": false }, - "GsaFileHeaderInfo": { - "required": [ - "fileHeaders" - ], - "type": "object", - "properties": { - "fileHeaders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileHeader" - } - } - }, - "additionalProperties": false - }, - "GsaFileMoveErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFileMoveErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFileAlreadyExistsFileMoveErrorDetail](#model-GsaFileAlreadyExistsFileMoveErrorDetail)\r\n * [GsaNoSuchNewParentFileMoveErrorDetail](#model-GsaNoSuchNewParentFileMoveErrorDetail)\r\n * [GsaSameParentFileMoveErrorDetail](#model-GsaSameParentFileMoveErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "fileAlreadyExists": "#/components/schemas/GsaFileAlreadyExistsFileMoveErrorDetail", - "noSuchNewParent": "#/components/schemas/GsaNoSuchNewParentFileMoveErrorDetail", - "sameParent": "#/components/schemas/GsaSameParentFileMoveErrorDetail" - } - } - }, - "GsaFileMoveErrorReason": { - "enum": [ - "fileAlreadyExists", - "noSuchNewParent", - "sameParent" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • fileAlreadyExists: A file with same name already exists as a child folder of the new parent.
    • \r\n
  • noSuchNewParent: A folder with the given GUID does not exist in database.
    • \r\n
  • sameParent: Unable to move file as it is already under this folder.
    • \r\n
\r\n" - }, - "GsaFileMoveException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "fileGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFileNameFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "The name is not a valid file name.\r\nYou cannot use directory separators or special characters in file or folder names.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileName'", - "x-discriminator-value": "fileName", - "x-discriminator-name": "reason" - }, - "GsaFileNameFolderErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "The name is not a valid file name.\r\nYou cannot use directory separators or special characters in file or folder names.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'fileName'", - "x-discriminator-value": "fileName", - "x-discriminator-name": "reason" - }, "GsaFilePrefixDatumCriterion": { "type": "object", "allOf": [ @@ -100178,37 +73752,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'filePrefix'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'filePrefix'", "x-discriminator-value": "filePrefix", "x-discriminator-name": "type" }, - "GsaFileUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "fileGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaFilesInfo": { "type": "object", "properties": { @@ -100222,71 +73769,12 @@ }, "additionalProperties": false }, - "GsaFindSimilarRequest": { - "required": [ - "similaritySettings" - ], - "type": "object", - "properties": { - "similaritySettings": { - "$ref": "#/components/schemas/GsaSimilaritySettings" - }, - "criterion": { - "$ref": "#/components/schemas/GsaFindSimilarSearchCriterion" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nsimilaritySettings: The settings to use for the similarity calculation\r\n\r\ncriterion: Optional filtering for records in the similarity calculation. If not provided, all records will be included." - }, - "GsaFindSimilarResponse": { + "GsaFindSearchRequest": { "type": "object", "properties": { - "findSimilarId": { + "nameContains": { "type": "string", - "description": "The Identifier of the find similar calculation", - "format": "uuid" - }, - "calculationComplete": { - "type": "boolean", - "description": "Indicates whether the calculation is complete. Granta.Server.Api.FindSimilar.FindSimilarResponse.Results will only be populated if this is true." - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFindSimilarResult" - }, - "description": "Results of the find similar calculation, only set if Granta.Server.Api.FindSimilar.FindSimilarResponse.CalculationComplete is true and Granta.Server.Api.FindSimilar.FindSimilarResponse.Error is not set.", "nullable": true - }, - "error": { - "$ref": "#/components/schemas/GsaErrorResponse" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nerror: Will be set if the calculation failed. If this is set, then" - }, - "GsaFindSimilarResult": { - "type": "object", - "properties": { - "recordGuid": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "double" - } - }, - "additionalProperties": false - }, - "GsaFindSimilarSearchCriterion": { - "type": "object", - "properties": { - "subsetCriterion": { - "$ref": "#/components/schemas/GsaRecordSubsetCriterion" - }, - "recordTypeCriterion": { - "$ref": "#/components/schemas/GsaRecordTypeCriterion" } }, "additionalProperties": false @@ -100323,7 +73811,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctionalGraph'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctionalGraph'", "x-discriminator-value": "floatFunctionalGraph", "x-discriminator-name": "datumType" }, @@ -100345,7 +73833,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", + "description": "Criterion for aggregating the graph information within a float functional attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", "x-discriminator-value": "floatFunctionalGraph", "x-discriminator-name": "type" }, @@ -100378,7 +73866,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, @@ -100398,7 +73886,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaFloatFunctionalAttributeParameter](#model-GsaFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -100427,7 +73915,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaFloatFunctionalAttributeParameter](#model-GsaFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -100446,7 +73934,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFloatFunctionalAttributeDiscreteParameter](#model-GsaFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaFloatFunctionalAttributeNumericParameter](#model-GsaFloatFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaFloatFunctionalAttributeDiscreteParameter\r\n * GsaFloatFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -100507,7 +73995,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * [GsaFloatFunctionalSeriesDatum](#model-GsaFloatFunctionalSeriesDatum)\r\n * [GsaFloatFunctionalGridDatum](#model-GsaFloatFunctionalGridDatum)", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'floatFunctional'\r\n\r\nThis is one of: \r\n * GsaFloatFunctionalSeriesDatum\r\n * GsaFloatFunctionalGridDatum", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "datumType" }, @@ -100544,7 +74032,7 @@ } ], "additionalProperties": false, - "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalData'", + "description": "floatFunctionalData: Criterion for matching records with float functional data\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalData'", "x-discriminator-value": "floatFunctionalData", "x-discriminator-name": "type" }, @@ -100559,7 +74047,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, @@ -100634,7 +74122,7 @@ } ], "additionalProperties": false, - "description": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", + "description": "floatFunctionalGraph: Criterion for matching records with float functional data\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctionalGraph'", "x-discriminator-value": "floatFunctionalGraph", "x-discriminator-name": "type" }, @@ -100657,7 +74145,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", + "description": "\r\n\r\nThis extends: GsaFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'", "x-discriminator-value": "grid", "x-discriminator-name": "graphType" }, @@ -100722,7 +74210,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaFloatFunctionalDatum](#model-GsaFloatFunctionalDatum)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", + "description": "\r\n\r\nThis extends: GsaFloatFunctionalDatum\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -100790,7 +74278,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGridGraph](#model-GsaGridGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", + "description": "\r\n\r\nThis extends: GsaGridGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", "x-discriminator-value": "float", "x-discriminator-name": "functionalType" }, @@ -100871,7 +74359,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", + "description": "\r\n\r\nThis extends: GsaSeriesGraph\r\n\r\nThe value of discriminator property ('functionalType') must be equal to 'float'", "x-discriminator-value": "float", "x-discriminator-name": "functionalType" }, @@ -100914,12 +74402,6 @@ "format": "uuid", "nullable": true }, - "hasFiles": { - "type": "boolean" - }, - "hasChildFolders": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -100930,242 +74412,6 @@ }, "additionalProperties": false }, - "GsaFolderAlreadyExistsFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "A folder with same name already exists as a child folder of the new parent.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'folderAlreadyExists'", - "x-discriminator-value": "folderAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaFolderCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFolderDeletionErrorDetail": { - "required": [ - "message" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFolderDeletionErrorReason" - } - }, - "additionalProperties": false - }, - "GsaFolderDeletionErrorReason": { - "enum": [ - "root" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • root: You cannot delete the root folder.
    • \r\n
\r\n" - }, - "GsaFolderDeletionException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderDeletionErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFolderErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFolderErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaFileNameFolderErrorDetail](#model-GsaFileNameFolderErrorDetail)\r\n * [GsaNamedEntityFolderErrorDetail](#model-GsaNamedEntityFolderErrorDetail)\r\n * [GsaUpdateRootFolderErrorDetail](#model-GsaUpdateRootFolderErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "fileName": "#/components/schemas/GsaFileNameFolderErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityFolderErrorDetail", - "updateRoot": "#/components/schemas/GsaUpdateRootFolderErrorDetail" - } - } - }, - "GsaFolderErrorReason": { - "enum": [ - "fileName", - "namedEntity", - "updateRoot" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • fileName: The name is not a valid file name.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • updateRoot: You cannot edit the root folder.
    • \r\n
\r\n" - }, - "GsaFolderMoveErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaFolderMoveErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCircularReferenceFolderMoveErrorDetail](#model-GsaCircularReferenceFolderMoveErrorDetail)\r\n * [GsaFolderAlreadyExistsFolderMoveErrorDetail](#model-GsaFolderAlreadyExistsFolderMoveErrorDetail)\r\n * [GsaNoSuchNewParentFolderMoveErrorDetail](#model-GsaNoSuchNewParentFolderMoveErrorDetail)\r\n * [GsaRootFolderMoveErrorDetail](#model-GsaRootFolderMoveErrorDetail)\r\n * [GsaSameParentFolderMoveErrorDetail](#model-GsaSameParentFolderMoveErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "circularReference": "#/components/schemas/GsaCircularReferenceFolderMoveErrorDetail", - "folderAlreadyExists": "#/components/schemas/GsaFolderAlreadyExistsFolderMoveErrorDetail", - "noSuchNewParent": "#/components/schemas/GsaNoSuchNewParentFolderMoveErrorDetail", - "root": "#/components/schemas/GsaRootFolderMoveErrorDetail", - "sameParent": "#/components/schemas/GsaSameParentFolderMoveErrorDetail" - } - } - }, - "GsaFolderMoveErrorReason": { - "enum": [ - "circularReference", - "folderAlreadyExists", - "noSuchNewParent", - "root", - "sameParent" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • circularReference: Circular reference found - you cannot move a folder to be a child of one of its descendants.
    • \r\n
  • folderAlreadyExists: A folder with same name already exists as a child folder of the new parent.
    • \r\n
  • noSuchNewParent: A folder with the given GUID does not exist in the database.
    • \r\n
  • root: You cannot move the root folder.
    • \r\n
  • sameParent: Unable to move folder as it is already under this folder.
    • \r\n
\r\n" - }, - "GsaFolderMoveException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaFolderType": { - "enum": [ - "homePage", - "helpPage", - "exporter", - "configuration" - ], - "type": "string" - }, - "GsaFolderUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaFoldersInfo": { "type": "object", "properties": { @@ -101179,21 +74425,6 @@ }, "additionalProperties": false }, - "GsaForbidOrphansRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "To set forbid orphans, all records in the target table must be linked to a record in the source table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'forbidOrphans'", - "x-discriminator-value": "forbidOrphans", - "x-discriminator-name": "reason" - }, "GsaFreeTextAggregation": { "type": "object", "allOf": [ @@ -101220,7 +74451,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: [GsaAggregation](#model-GsaAggregation)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "description": "The results of aggregation over an attribute.\r\n\r\nThis extends: GsaAggregation\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", "x-discriminator-value": "text", "x-discriminator-name": "type" }, @@ -101257,7 +74488,7 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting a free text aggregation over a set of attributes and tabular local columns.\r\nUses ValueSpecifiers to specify how to filter on attributes and local columns.\r\nAt least one filter must be specified.\r\n\r\nThis extends: [GsaAggregationCriterion](#model-GsaAggregationCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "description": "A criterion for requesting a free text aggregation over a set of attributes and tabular local columns.\r\nUses ValueSpecifiers to specify how to filter on attributes and local columns.\r\nAt least one filter must be specified.\r\n\r\nThis extends: GsaAggregationCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", "x-discriminator-value": "text", "x-discriminator-name": "type" }, @@ -101312,7 +74543,7 @@ } ], "additionalProperties": false, - "description": "Base type for free text criteria.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "description": "Base type for free text criteria.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", "x-discriminator-value": "text", "x-discriminator-name": "type" }, @@ -101369,7 +74600,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'textPrefix'", + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'textPrefix'", "x-discriminator-value": "textPrefix", "x-discriminator-name": "type" }, @@ -101395,7 +74626,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutSection](#model-GsaLayoutSection)\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'full'", + "description": "\r\n\r\nThis extends: GsaLayoutSection\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'full'", "x-discriminator-value": "full", "x-discriminator-name": "sectionDetailType" }, @@ -101416,7 +74647,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'fullName'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'fullName'", "x-discriminator-value": "fullName", "x-discriminator-name": "propertyName" }, @@ -101431,25 +74662,10 @@ } ], "additionalProperties": false, - "description": "Functional attributes must have at least one parameter.\r\nFunctional attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'funcNoParams'", + "description": "Functional attributes must have at least one parameter.\r\nFunctional attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'funcNoParams'", "x-discriminator-value": "funcNoParams", "x-discriminator-name": "reason" }, - "GsaFunctionalDataDefaultUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'functionalDataDefault'", - "x-discriminator-value": "functionalDataDefault", - "x-discriminator-name": "referencedByType" - }, "GsaFunctionalDatumParameterInfo": { "type": "object", "properties": { @@ -101526,21 +74742,6 @@ "type": "string", "description": "

Possible values:

\r\n
    \r\n
  • float: Float functional
    • \r\n
  • discrete: Discrete functional
    • \r\n
\r\n" }, - "GsaGeneralUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'general'", - "x-discriminator-value": "general", - "x-discriminator-name": "reason" - }, "GsaGeneratedIntegrationSchemaOfObjectIdentifier": { "required": [ "schema" @@ -101598,7 +74799,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -101612,11 +74813,11 @@ }, "GsaGetUnitConversionsRequest": { "required": [ - "conversions" + "sourceUnits" ], "type": "object", "properties": { - "conversions": { + "sourceUnits": { "type": "array", "items": { "$ref": "#/components/schemas/GsaUnitConversionSetRequest" @@ -101625,26 +74826,6 @@ }, "additionalProperties": false }, - "GsaGetUnitEquivalentsException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaGraph": { "required": [ "graphType" @@ -101656,7 +74837,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSeriesGraph](#model-GsaSeriesGraph)\r\n * [GsaGridGraph](#model-GsaGridGraph)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSeriesGraph\r\n * GsaGridGraph", "discriminator": { "propertyName": "graphType", "mapping": { @@ -101700,7 +74881,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteGraphParameterValue](#model-GsaDiscreteGraphParameterValue)\r\n * [GsaNumericGraphParameterValue](#model-GsaNumericGraphParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteGraphParameterValue\r\n * GsaNumericGraphParameterValue", "discriminator": { "propertyName": "parameterType", "mapping": { @@ -101745,7 +74926,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteGraphValue](#model-GsaDiscreteGraphValue)\r\n * [GsaRangeGraphValue](#model-GsaRangeGraphValue)\r\n * [GsaNoValueExistsGraphValue](#model-GsaNoValueExistsGraphValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteGraphValue\r\n * GsaRangeGraphValue\r\n * GsaNoValueExistsGraphValue", "discriminator": { "propertyName": "graphValueType", "mapping": { @@ -101763,31 +74944,6 @@ ], "type": "string" }, - "GsaGrid": { - "required": [ - "headers", - "rows" - ], - "type": "object", - "properties": { - "headers": { - "type": "array", - "items": { - "type": "string" - } - }, - "rows": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "additionalProperties": false - }, "GsaGridGraph": { "type": "object", "allOf": [ @@ -101825,7 +74981,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraph](#model-GsaGraph)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'\r\n\r\nThis is one of: \r\n * [GsaFloatGridGraph](#model-GsaFloatGridGraph)\r\n * [GsaDiscreteGridGraph](#model-GsaDiscreteGridGraph)", + "description": "\r\n\r\nThis extends: GsaGraph\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'grid'\r\n\r\nThis is one of: \r\n * GsaFloatGridGraph\r\n * GsaDiscreteGridGraph", "x-discriminator-value": "grid", "x-discriminator-name": "graphType" }, @@ -102005,9 +75161,6 @@ }, "securityGroups": { "$ref": "#/components/schemas/GsaSecurityGroups" - }, - "similaritySettings": { - "$ref": "#/components/schemas/GsaSimilaritySettings" } }, "additionalProperties": false, @@ -102086,28 +75239,6 @@ "additionalProperties": false, "description": "A source table from which integrated data will be taken." }, - "GsaHelpPathsValidationResponse": { - "required": [ - "attributes", - "parameters" - ], - "type": "object", - "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimAttributeWithHelpPath" - } - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimParameterWithHelpPath" - } - } - }, - "additionalProperties": false - }, "GsaHistogram": { "type": "object", "properties": { @@ -102151,7 +75282,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -102182,7 +75313,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "datumType" }, @@ -102205,7 +75336,7 @@ } ], "additionalProperties": false, - "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "hyperlink: Criterion for matching records where the hyperlink description contains the given value.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -102220,7 +75351,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -102243,7 +75374,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlinkPrefix'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlinkPrefix'", "x-discriminator-value": "hyperlinkPrefix", "x-discriminator-name": "type" }, @@ -102259,63 +75390,6 @@ "type": "string", "description": "A target for a `HyperlinkDatum`

Possible values:

\r\n
    \r\n
  • newWindow: Target a new window (equivalent to \"_blank\").
    • \r\n
  • top: Target the topmost frame of the current frameset (equivalent to \"_top\").
    • \r\n
  • parent: Target the parent frame of the current frame (equivalent to \"_parent\").
    • \r\n
  • tree: Target the left-hand side frame.
    • \r\n
  • content: Target the right-hand side frame.
    • \r\n
  • currentFrame: Target the current frame (equivalent to \"_self\").
    • \r\n
\r\n" }, - "GsaInUseParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "parameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "usedByType": { - "$ref": "#/components/schemas/GsaParameterValueUsedByType" - } - } - } - ], - "additionalProperties": false, - "description": "The parameter value is being used by an attribute.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'inUse'", - "x-discriminator-value": "inUse", - "x-discriminator-name": "reason" - }, - "GsaInclusiveness": { - "enum": [ - "inclusive", - "exclusive" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • inclusive: Inclusive
    • \r\n
  • exclusive: Exclusive
    • \r\n
\r\n" - }, - "GsaIncompatibleUnitsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - { - "type": "object", - "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" - }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'incompatibleUnits'", - "x-discriminator-value": "incompatibleUnits", - "x-discriminator-name": "reason" - }, "GsaIndexRecordFailure": { "type": "object", "properties": { @@ -102348,41 +75422,6 @@ ], "type": "string" }, - "GsaInputConnectionDetails": { - "required": [ - "dataSource", - "initialCatalog" - ], - "type": "object", - "properties": { - "dataSource": { - "type": "string", - "description": "The SQL server data source" - }, - "initialCatalog": { - "type": "string", - "description": "The name of the database in SQL server" - }, - "useConfigurationDatabaseCredentials": { - "type": "boolean", - "description": "Set to true if the SQL connection should use the credentials from the Configuration database." - }, - "useIntegratedSecurity": { - "type": "boolean", - "description": "Set to true if the SQL connection to the database should use Windows authentication" - }, - "sqlCredentials": { - "$ref": "#/components/schemas/GsaSqlCredentials" - }, - "additionalSqlParameters": { - "type": "string", - "description": "(Optional) Any additional parameters that will be added to the SQL connection string for the database. Must be a valid SQL connection string format.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "\r\n\r\nsqlCredentials: The credentials to use if the database should use SQL authentication." - }, "GsaInputValidationErrorDetail": { "required": [ "message", @@ -102422,7 +75461,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "datumType" }, @@ -102437,7 +75476,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain the minimum and maximum\r\nvalues, and a count of records with a value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -102461,28 +75500,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", - "x-discriminator-value": "integer", - "x-discriminator-name": "type" - }, - "GsaIntegerChartData": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaChartData" - }, - { - "type": "object", - "properties": { - "value": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -102506,7 +75524,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "datumType" }, @@ -102535,7 +75553,7 @@ } ], "additionalProperties": false, - "description": "integer: Criterion for matching records where the integer data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "integer: Criterion for matching records where the integer data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -102550,7 +75568,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -102577,7 +75595,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerFixedWidthHistogram'", + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerFixedWidthHistogram'", "x-discriminator-value": "integerFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -102597,7 +75615,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integerHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'integerHistogram'", "x-discriminator-value": "integerHistogram", "x-discriminator-name": "datumType" }, @@ -102618,7 +75636,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerHistogram'", + "description": "Criterion for aggregating data within an integer attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'integerHistogram'", "x-discriminator-value": "integerHistogram", "x-discriminator-name": "type" }, @@ -102876,9 +75894,6 @@ }, "securityGroups": { "$ref": "#/components/schemas/GsaSecurityGroups" - }, - "similaritySettings": { - "$ref": "#/components/schemas/GsaSimilaritySettings" } }, "additionalProperties": false, @@ -102968,54 +75983,6 @@ }, "additionalProperties": false }, - "GsaInvalidEquivalenceTargetErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - { - "type": "object", - "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" - }, - "unitSystemGuid": { - "type": "string", - "format": "uuid" - }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" - }, - "equivalentOfEquivalentUnitGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidEquivalenceTarget'", - "x-discriminator-value": "invalidEquivalenceTarget", - "x-discriminator-name": "reason" - }, - "GsaInvalidExchangeRateCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency conversion factor must be greater than zero.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidExchangeRate'", - "x-discriminator-value": "invalidExchangeRate", - "x-discriminator-name": "reason" - }, "GsaInvalidKeyAddDatabaseValidationIssue": { "type": "object", "allOf": [ @@ -103035,7 +76002,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'invalidKey'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'invalidKey'", "x-discriminator-value": "invalidKey", "x-discriminator-name": "IssueType" }, @@ -103050,7 +76017,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidParentState'", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidParentState'", "x-discriminator-value": "invalidParentState", "x-discriminator-name": "reason" }, @@ -103070,7 +76037,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidVersionState'", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'invalidVersionState'", "x-discriminator-value": "invalidVersionState", "x-discriminator-name": "reason" }, @@ -103199,7 +76166,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedByUser'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedByUser'", "x-discriminator-value": "lastModifiedByUser", "x-discriminator-name": "propertyName" }, @@ -103220,7 +76187,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedDate'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'lastModifiedDate'", "x-discriminator-value": "lastModifiedDate", "x-discriminator-name": "propertyName" }, @@ -103252,8 +76219,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -103306,13 +76272,12 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutItem](#model-GsaLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", + "description": "\r\n\r\nThis extends: GsaLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", "x-discriminator-value": "attribute", "x-discriminator-name": "itemType" }, "GsaLayoutItem": { "required": [ - "displayNames", "guid", "itemType", "name", @@ -103327,14 +76292,6 @@ "type": "string", "format": "uuid" }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -103344,7 +76301,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaLayoutAttributeItem](#model-GsaLayoutAttributeItem)\r\n * [GsaLayoutLinkItem](#model-GsaLayoutLinkItem)", + "description": "\r\n\r\nThis is one of: \r\n * GsaLayoutAttributeItem\r\n * GsaLayoutLinkItem", "discriminator": { "propertyName": "itemType", "mapping": { @@ -103415,7 +76372,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutItem](#model-GsaLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "itemType" }, @@ -103436,8 +76393,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -103448,7 +76404,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSlimLayoutSection](#model-GsaSlimLayoutSection)\r\n * [GsaFullLayoutSection](#model-GsaFullLayoutSection)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSlimLayoutSection\r\n * GsaFullLayoutSection", "discriminator": { "propertyName": "sectionDetailType", "mapping": { @@ -103517,62 +76473,6 @@ }, "additionalProperties": false }, - "GsaLink": { - "required": [ - "displayNames", - "guid", - "linkInfo", - "name", - "reverseName", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaLinkAttributeType" - }, - "reverseName": { - "type": "string" - }, - "reverseDisplayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "linkInfo": { - "$ref": "#/components/schemas/GsaLinkInfo" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordLink](#model-GsaRecordLink)\r\n * [GsaSmartLink](#model-GsaSmartLink)\r\n * [GsaCrossDatabaseLink](#model-GsaCrossDatabaseLink)\r\n * [GsaTabularAttributeLink](#model-GsaTabularAttributeLink)", - "discriminator": { - "propertyName": "type", - "mapping": { - "recordLink": "#/components/schemas/GsaRecordLink", - "smartLink": "#/components/schemas/GsaSmartLink", - "crossDatabaseLink": "#/components/schemas/GsaCrossDatabaseLink", - "tabularAttribute": "#/components/schemas/GsaTabularAttributeLink" - } - } - }, "GsaLinkAggregation": { "type": "object", "allOf": [ @@ -103593,7 +76493,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "datumType" }, @@ -103617,7 +76517,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a tabular attribute. The local columns specified will be individually aggregated\r\nacross all rows (including rows without linked records, which may be hidden in clients).\r\n \r\nThe returned aggregation will contain a list of the individual column aggregations that have been performed. Within these\r\ncolumn aggregations, the 'record count' instead denotes the number of relevant tabular rows across all records in the\r\naggregation scope, rather than the number of records. This row count will include rows that may be hidden from the user's\r\nview in certain clients.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "Criterion for aggregating data within a tabular attribute. The local columns specified will be individually aggregated\r\nacross all rows (including rows without linked records, which may be hidden in clients).\r\n \r\nThe returned aggregation will contain a list of the individual column aggregations that have been performed. Within these\r\ncolumn aggregations, the 'record count' instead denotes the number of relevant tabular rows across all records in the\r\naggregation scope, rather than the number of records. This row count will include rows that may be hidden from the user's\r\nview in certain clients.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -103688,7 +76588,7 @@ } ], "additionalProperties": false, - "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: [GsaAttributeToExport](#model-GsaAttributeToExport)\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'link'", + "description": "Export request information for a 'link' attribute.\r\n\r\nThis extends: GsaAttributeToExport\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "attributeType" }, @@ -103696,7 +76596,7 @@ "enum": [ "recordLink", "crossDatabaseLink", - "smartLink", + "dynamicLink", "tabularAttribute" ], "type": "string" @@ -103764,7 +76664,7 @@ } ], "additionalProperties": false, - "description": "link: Criterion for matching records that are linked to records that match the inner criterion. The target database and table specify the location of the linked records.\r\nThe inner criterion must be a criterion that applies to the records in the linked table. The link group followed will be the link group specified on the outer AttributeCriterion.\r\nA target database is required unless searching local tabular data - In that case, the inner criterion must be absent, and the local criterion will be used.\r\n\r\nlocalCriterion: Criterion to filter local properties of the link. For a tabular attribute search, this will be a criterion against the local columns and so it will use column ids/guids instead of attribute ones. For other types of link, this is currently unused.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\ninnerCriterion: Criterion to run to filter the linked records. When running linked search for tabular attribute we are searching against actual records and attributes, so attribute ids/guids should be used instead of column ids/guids.\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns, or a tabular data exists search.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "link: Criterion for matching records that are linked to records that match the inner criterion. The target database and table specify the location of the linked records.\r\nThe inner criterion must be a criterion that applies to the records in the linked table. The link group followed will be the link group specified on the outer AttributeCriterion.\r\nA target database is required unless searching local tabular data - In that case, the inner criterion must be absent, and the local criterion will be used.\r\n\r\nlocalCriterion: Criterion to filter local properties of the link. For a tabular attribute search, this will be a criterion against the local columns and so it will use column ids/guids instead of attribute ones. For other types of link, this is currently unused.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\ninnerCriterion: Criterion to run to filter the linked records. When running linked search for tabular attribute we are searching against actual records and attributes, so attribute ids/guids should be used instead of column ids/guids.\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns, or a tabular data exists search.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -103824,7 +76724,7 @@ } ], "additionalProperties": false, - "description": "link: Criterion for matching records that are linked to records by the given link group. The target database and table specify the location of the linked records.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "link: Criterion for matching records that are linked to records by the given link group. The target database and table specify the location of the linked records.\r\n\r\nindirectLinks: For static and cross database links: whether the search should consider indirect links between records. The default is to decide based on the definition of the links\r\n\r\nlocalRowsBehavior: For tabular searching: Additional row filtering behavior for a search against local columns\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -103847,7 +76747,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -103904,30 +76804,25 @@ "description": "Source links for an integration schema can either be static (within an single database), or cross database. Cross database links\r\nmust indicate which database they are defined in - a reverse cross database link is defined in the \"target\" database of the mapped\r\nintegration schema attribute.

Possible values:

\r\n
    \r\n
  • recordLink: A static record link that links records within a single database.
    • \r\n
  • crossDatabaseLink: Links records across multiple databases.
    • \r\n
  • reverseCrossDatabaseLink: Links records across multiple databases, and is defined in the \"target\" database of the mapped integration schema attribute. Links records in that database to the source database defined in the mapping.
    • \r\n
\r\n" }, "GsaLinkTarget": { - "required": [ - "tableGuid" - ], "type": "object", "properties": { "databaseGuid": { "type": "string", - "description": "Gets the guid of the database that this link group is referencing.\r\nIf `null` it means match any database with a matching table (only the case for cross database links)", "format": "uuid", "nullable": true }, "databaseVersionGuid": { "type": "string", - "description": "Database version GUID. Null for forwards cross database link targets.", "format": "uuid", "nullable": true }, "tableGuid": { "type": "string", - "format": "uuid" + "format": "uuid", + "nullable": true } }, - "additionalProperties": false, - "description": "The target of a link group. Use /schema:resolve-link-targets to find all the currently loaded tables that match this target" + "additionalProperties": false }, "GsaLinkedAttributeTabularColumn": { "type": "object", @@ -103948,7 +76843,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", "x-discriminator-value": "linkedAttribute", "x-discriminator-name": "columnType" }, @@ -103978,7 +76873,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nlinkedAttribute: The tabular attribute that the linked column belongs to. The target of this tabular attribute is linkedTarget.\r\n\r\nlinkedColumn: The tabular column in the tabular linkedAttribute. Data from this column will be included.\r\n\r\nlinkedTarget: The target of the tabular linkedAttribute.\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "description": "\r\n\r\nlinkedAttribute: The tabular attribute that the linked column belongs to. The target of this tabular attribute is linkedTarget.\r\n\r\nlinkedColumn: The tabular column in the tabular linkedAttribute. Data from this column will be included.\r\n\r\nlinkedTarget: The target of the tabular linkedAttribute.\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", "x-discriminator-value": "linkedColumn", "x-discriminator-name": "columnType" }, @@ -104017,7 +76912,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", "x-discriminator-value": "linkedRecord", "x-discriminator-name": "columnType" }, @@ -104041,8 +76936,8 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smartLinkingValue'", - "x-discriminator-value": "smartLinkingValue", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamicLinkingValue'", + "x-discriminator-value": "dynamicLinkingValue", "x-discriminator-name": "type" }, "GsaLinkingValueMatchBehavior": { @@ -104064,7 +76959,7 @@ "links": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaLink" + "$ref": "#/components/schemas/GsaResolvedLink" } } }, @@ -104184,7 +77079,7 @@ } ], "additionalProperties": false, - "description": "listBoolean: Criterion that wraps other criteria in order to specify how the results should be joined together. Used in searches for record lists.\r\n\r\nThis extends: [GsaListCriterion](#model-GsaListCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'listBoolean'", + "description": "listBoolean: Criterion that wraps other criteria in order to specify how the results should be joined together. Used in searches for record lists.\r\n\r\nThis extends: GsaListCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'listBoolean'", "x-discriminator-value": "listBoolean", "x-discriminator-name": "type" }, @@ -104199,7 +77094,7 @@ } }, "additionalProperties": false, - "description": "The criterion to be used in a search for record lists.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\" or \"all\" of the criteria.\r\nThese criteria can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * [GsaListBooleanCriterion](#model-GsaListBooleanCriterion)\r\n * [GsaRecordListSearchCriterion](#model-GsaRecordListSearchCriterion)", + "description": "The criterion to be used in a search for record lists.\r\n \r\nMultiple criterion can be provided. These should be wrapped with a boolean criterion that specifies whether the search should return results that match \"any\" or \"all\" of the criteria.\r\nThese criteria can be nested to created complex search queries.\r\n\r\nThis is one of: \r\n * GsaListBooleanCriterion\r\n * GsaRecordListSearchCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -104352,7 +77247,7 @@ } }, "additionalProperties": false, - "description": "The results of aggregation over a tabular local column. In all cases this will report the number of rows in\r\nthe aggregation scope that have a value for the local column. In some cases, depending on the datum\r\ntype, we may be able to report more information. For example, aggregating over a numeric datum will\r\nalso provide the minimum and maximum values that local column takes across records in the aggregation\r\nscope.\r\n\r\nThis is one of: \r\n * [GsaLocalColumnValueAggregation](#model-GsaLocalColumnValueAggregation)\r\n * [GsaLocalColumnExistsAggregation](#model-GsaLocalColumnExistsAggregation)", + "description": "The results of aggregation over a tabular local column. In all cases this will report the number of rows in\r\nthe aggregation scope that have a value for the local column. In some cases, depending on the datum\r\ntype, we may be able to report more information. For example, aggregating over a numeric datum will\r\nalso provide the minimum and maximum values that local column takes across records in the aggregation\r\nscope.\r\n\r\nThis is one of: \r\n * GsaLocalColumnValueAggregation\r\n * GsaLocalColumnExistsAggregation", "discriminator": { "propertyName": "localColumnAggregationType", "mapping": { @@ -104382,7 +77277,7 @@ } }, "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column. Exactly one of the identity or GUID must be provided.\r\n\r\nThis is one of: \r\n * [GsaLocalColumnAggregationValueCriterion](#model-GsaLocalColumnAggregationValueCriterion)\r\n * [GsaLocalColumnAggregationExistsCriterion](#model-GsaLocalColumnAggregationExistsCriterion)", + "description": "A criterion for requesting aggregations for a single specific tabular local column. Exactly one of the identity or GUID must be provided.\r\n\r\nThis is one of: \r\n * GsaLocalColumnAggregationValueCriterion\r\n * GsaLocalColumnAggregationExistsCriterion", "discriminator": { "propertyName": "localColumnAggregationCriterionType", "mapping": { @@ -104407,7 +77302,7 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: [GsaLocalColumnAggregationCriterion](#model-GsaLocalColumnAggregationCriterion)\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'exists'", + "description": "A criterion for requesting aggregations for a single specific tabular local column.\r\n\r\nThis extends: GsaLocalColumnAggregationCriterion\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "localColumnAggregationCriterionType" }, @@ -104434,7 +77329,7 @@ } ], "additionalProperties": false, - "description": "A criterion for requesting aggregations for a single specific tabular local column,\r\nincluding summary information about the values assumed by the local column.\r\n \r\nFor a numeric local column (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the local column.\r\n \r\nFor a simple text local column (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that local column.\r\n\r\nThis extends: [GsaLocalColumnAggregationCriterion](#model-GsaLocalColumnAggregationCriterion)\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'value'", + "description": "A criterion for requesting aggregations for a single specific tabular local column,\r\nincluding summary information about the values assumed by the local column.\r\n \r\nFor a numeric local column (integer, point, range, or date-time), the summary information will\r\nbe the minimum and maximum values assumed by the local column.\r\n \r\nFor a simple text local column (discrete, short-text), the summary information will be the most\r\ncommon terms in the search index for that local column.\r\n\r\nThis extends: GsaLocalColumnAggregationCriterion\r\n\r\nThe value of discriminator property ('localColumnAggregationCriterionType') must be equal to 'value'", "x-discriminator-value": "value", "x-discriminator-name": "localColumnAggregationCriterionType" }, @@ -104475,7 +77370,7 @@ } ], "additionalProperties": false, - "description": "Base class for local column criterions. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'localColumn'\r\n\r\nThis is one of: \r\n * [GsaLocalColumnMatchesCriterion](#model-GsaLocalColumnMatchesCriterion)\r\n * [GsaLocalColumnExistsCriterion](#model-GsaLocalColumnExistsCriterion)\r\n * [GsaLocalColumnNotApplicableCriterion](#model-GsaLocalColumnNotApplicableCriterion)", + "description": "Base class for local column criterions. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'localColumn'\r\n\r\nThis is one of: \r\n * GsaLocalColumnMatchesCriterion\r\n * GsaLocalColumnExistsCriterion\r\n * GsaLocalColumnNotApplicableCriterion", "x-discriminator-value": "localColumn", "x-discriminator-name": "type" }, @@ -104498,7 +77393,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over a tabular local column, reporting only the number of rows with a value\r\nfor the local column.\r\n\r\nThis extends: [GsaLocalColumnAggregation](#model-GsaLocalColumnAggregation)\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'exists'", + "description": "The results of aggregation over a tabular local column, reporting only the number of rows with a value\r\nfor the local column.\r\n\r\nThis extends: GsaLocalColumnAggregation\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "localColumnAggregationType" }, @@ -104521,7 +77416,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching record where there is data on the tabular local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'exists'", + "description": "Criterion for matching record where there is data on the tabular local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'exists'", "x-discriminator-value": "exists", "x-discriminator-name": "localColumnCriterionType" }, @@ -104544,7 +77439,7 @@ } ], "additionalProperties": false, - "description": "Criterion for a search matching values in a given tabular local column. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'matches'", + "description": "Criterion for a search matching values in a given tabular local column. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'matches'", "x-discriminator-value": "matches", "x-discriminator-name": "localColumnCriterionType" }, @@ -104559,7 +77454,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching record where there is not applicable data on the local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: [GsaLocalColumnCriterion](#model-GsaLocalColumnCriterion)\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'notApplicable'", + "description": "Criterion for matching record where there is not applicable data on the local column specified. Exactly one of the local column identity or GUID must be provided.\r\n\r\nThis extends: GsaLocalColumnCriterion\r\n\r\nThe value of discriminator property ('localColumnCriterionType') must be equal to 'notApplicable'", "x-discriminator-value": "notApplicable", "x-discriminator-name": "localColumnCriterionType" }, @@ -104579,7 +77474,7 @@ } ], "additionalProperties": false, - "description": "The results of aggregation over a tabular local column, reporting the number of rows that have a value for\r\nthe local column, plus additional aggregation information about the local column values. The exact type of\r\nadditional information will depend on the type of local column.\r\n\r\nThis extends: [GsaLocalColumnAggregation](#model-GsaLocalColumnAggregation)\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'value'", + "description": "The results of aggregation over a tabular local column, reporting the number of rows that have a value for\r\nthe local column, plus additional aggregation information about the local column values. The exact type of\r\nadditional information will depend on the type of local column.\r\n\r\nThis extends: GsaLocalColumnAggregation\r\n\r\nThe value of discriminator property ('localColumnAggregationType') must be equal to 'value'", "x-discriminator-value": "value", "x-discriminator-name": "localColumnAggregationType" }, @@ -104602,7 +77497,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", "x-discriminator-value": "localDateTime", "x-discriminator-name": "columnType" }, @@ -104629,7 +77524,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", "x-discriminator-value": "localDiscrete", "x-discriminator-name": "columnType" }, @@ -104652,7 +77547,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", "x-discriminator-value": "localFile", "x-discriminator-name": "columnType" }, @@ -104675,7 +77570,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", "x-discriminator-value": "localHyperlink", "x-discriminator-name": "columnType" }, @@ -104698,7 +77593,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", "x-discriminator-value": "localInteger", "x-discriminator-name": "columnType" }, @@ -104721,7 +77616,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", "x-discriminator-value": "localLogical", "x-discriminator-name": "columnType" }, @@ -104744,7 +77639,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", "x-discriminator-value": "localLongText", "x-discriminator-name": "columnType" }, @@ -104767,7 +77662,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", "x-discriminator-value": "localPicture", "x-discriminator-name": "columnType" }, @@ -104793,7 +77688,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", "x-discriminator-value": "localPoint", "x-discriminator-name": "columnType" }, @@ -104819,7 +77714,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", "x-discriminator-value": "localRange", "x-discriminator-name": "columnType" }, @@ -104852,25 +77747,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", "x-discriminator-value": "localShortText", "x-discriminator-name": "columnType" }, - "GsaLogScaleNegativeParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "For a log-scale parameter, all values must be greater than zero.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'logScaleNegative'", - "x-discriminator-value": "logScaleNegative", - "x-discriminator-name": "reason" - }, "GsaLogicalAggregation": { "type": "object", "allOf": [ @@ -104891,7 +77771,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "datumType" }, @@ -104906,7 +77786,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a logical attribute. The returned aggregation will contain a count of records with at least one value for the attribute,\r\nand a count of records for the true/false values.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "Criterion for aggregating data within a logical attribute. The returned aggregation will contain a count of records with at least one value for the attribute,\r\nand a count of records for the true/false values.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -104921,27 +77801,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", - "x-discriminator-value": "logical", - "x-discriminator-name": "type" - }, - "GsaLogicalChartData": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaChartData" - }, - { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -104964,7 +77824,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "datumType" }, @@ -104988,7 +77848,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -105003,7 +77863,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -105024,7 +77884,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'long'", + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'long'", "x-discriminator-value": "long", "x-discriminator-name": "type" }, @@ -105039,7 +77899,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -105062,7 +77922,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "datumType" }, @@ -105086,7 +77946,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -105101,7 +77961,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -105124,25 +77984,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longTextPrefix'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'longTextPrefix'", "x-discriminator-value": "longTextPrefix", "x-discriminator-name": "type" }, - "GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The Many to Many model cannot forbid orphans.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'manyToManyForbidOrphans'", - "x-discriminator-value": "manyToManyForbidOrphans", - "x-discriminator-name": "reason" - }, "GsaMappingOfObjectIdentifier": { "type": "object", "properties": { @@ -105174,15 +78019,6 @@ "additionalProperties": false, "description": "A mapping between a source database item and an integration schema attribute." }, - "GsaMatchMode": { - "enum": [ - "BasicGuidMatch", - "MatchOnGuidThenName", - "FullGuidSync" - ], - "type": "string", - "description": "How to match update items.

Possible values:

\r\n
    \r\n
  • BasicGuidMatch: Items are matched based on their guids alone.
    • \r\n
  • MatchOnGuidThenName: Items are matched based on their guids. Missing items are matched on name.
    • \r\n
  • FullGuidSync: Items are matched on their guids. Missing items are matched on name and have their guids rewritten to match those from the update file.
    • \r\n
\r\n" - }, "GsaMathsContent": { "required": [ "parameterContents", @@ -105268,7 +78104,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -105292,7 +78128,7 @@ } ], "additionalProperties": false, - "description": "Errors specific to Maths Functional attributes.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'mathsFunctional'", + "description": "Errors specific to Maths Functional attributes.\r\nSee \"errors\" for details.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "reason" }, @@ -105329,7 +78165,7 @@ } ], "additionalProperties": false, - "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "mathsFunctional: Criterion for matching records with maths functional data (EELs)\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -105344,7 +78180,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -105363,7 +78199,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail](#model-GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail)\r\n * [GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail](#model-GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail)\r\n * [GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail](#model-GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail)\r\n * [GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail](#model-GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail)\r\n * [GsaExpressionMathsFunctionalErrorDetail](#model-GsaExpressionMathsFunctionalErrorDetail)\r\n * [GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail](#model-GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail)\r\n * [GsaNoExpressionsMathsFunctionalErrorDetail](#model-GsaNoExpressionsMathsFunctionalErrorDetail)\r\n * [GsaNoSuchExpressionsMathsFunctionalErrorDetail](#model-GsaNoSuchExpressionsMathsFunctionalErrorDetail)\r\n * [GsaParameterContentMathsFunctionalErrorDetail](#model-GsaParameterContentMathsFunctionalErrorDetail)\r\n * [GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail](#model-GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail)\r\n * [GsaParameterContentUnknownParametersMathsFunctionalErrorDetail](#model-GsaParameterContentUnknownParametersMathsFunctionalErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaAnonymousExpressionsMustAllowAllCompatibleMathsFunctionalErrorDetail\r\n * GsaDefaultExpressionNotFoundMathsFunctionalErrorDetail\r\n * GsaDefaultFreeParameterNotFoundMathsFunctionalErrorDetail\r\n * GsaDuplicateExpressionGuidsMathsFunctionalErrorDetail\r\n * GsaExpressionMathsFunctionalErrorDetail\r\n * GsaExpressionsHaveUnknownParametersMathsFunctionalErrorDetail\r\n * GsaNoExpressionsMathsFunctionalErrorDetail\r\n * GsaNoSuchExpressionsMathsFunctionalErrorDetail\r\n * GsaParameterContentMathsFunctionalErrorDetail\r\n * GsaParameterContentDuplicateGuidsMathsFunctionalErrorDetail\r\n * GsaParameterContentUnknownParametersMathsFunctionalErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -105395,47 +78231,7 @@ "parameterContentDuplicateGuids", "parameterContentUnknownParameters" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • anonymousExpressionsMustAllowAllCompatible: Anonymous expressions cannot be allowed without allowing all compatible expressions.
    • \r\n
  • defaultExpressionNotFound: Default expression must be from attribute's expressions.
    • \r\n
  • defaultFreeParameterNotFound: Default free parameter must be from attribute's parameters.
    • \r\n
  • duplicateExpressionGuids: No duplicate expression GUIDs allowed.
    • \r\n
  • expression: Expression is invalid. See \"errors\" for details.
    • \r\n
  • expressionsHaveUnknownParameters: Parameter lists lacks some parameters required by the chosen expressions.
    • \r\n
  • noExpressions: Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.
    • \r\n
  • noSuchExpressions: The not found GUIDs do not correspond to existing expressions.
    • \r\n
  • parameterContent: ParameterContent is not valid. See \"errors\" for details.
    • \r\n
  • parameterContentDuplicateGuids: No duplicate parameter GUIDs allowed in parameter contents.
    • \r\n
  • parameterContentUnknownParameters: Parameters in parameter contents must be from this attribute's parameters.
    • \r\n
\r\n" - }, - "GsaMaxPermissionsReachedPermissionErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - { - "required": [ - "maxNumberOfPermissions" - ], - "type": "object", - "properties": { - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "There are no more permissions available, the maximum number has been reached.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'maxPermissionsReached'", - "x-discriminator-value": "maxPermissionsReached", - "x-discriminator-name": "reason" - }, - "GsaMetaAttributeCannotHaveMetaAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Meta-attribute Cannot have a meta-attribute.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'metaAttributeCannotHaveMetaAttribute'", - "x-discriminator-value": "metaAttributeCannotHaveMetaAttribute", - "x-discriminator-name": "reason" + "type": "string" }, "GsaMfaExpressionErrorDetail": { "required": [ @@ -105469,604 +78265,149 @@ "type": "string" }, "version": { - "type": "string" - }, - "majorMinorVersion": { - "type": "string" - } - }, - "additionalProperties": false - }, - "GsaMissingArgumentsParameterContentErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterContentErrorDetail" - }, - { - "type": "object", - "properties": { - "missingArgument": { - "$ref": "#/components/schemas/GsaParameterContentMissingArgument" - } - } - } - ], - "additionalProperties": false, - "description": "MissingArgument must be provided.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingArguments'", - "x-discriminator-value": "missingArguments", - "x-discriminator-name": "reason" - }, - "GsaMissingParameterGuidAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "All supplied attribute parameters must have parameter GUIDs specified.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingParameterGuid'", - "x-discriminator-value": "missingParameterGuid", - "x-discriminator-name": "reason" - }, - "GsaMoveFile": { - "required": [ - "folderGuid" - ], - "type": "object", - "properties": { - "folderGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaMoveFolder": { - "required": [ - "parentGuid" - ], - "type": "object", - "properties": { - "parentGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaMoveRecordHistory": { - "type": "object", - "properties": { - "newParent": { - "$ref": "#/components/schemas/GsaSlimRecordHistory" - } - }, - "additionalProperties": false - }, - "GsaMultiValuedPointDataUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'multiValuedPointData'", - "x-discriminator-value": "multiValuedPointData", - "x-discriminator-name": "referencedByType" - }, - "GsaMultipleTableDiscreteValuesInSingleValuedDiscreteErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "tableDiscreteValueCount": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'multipleDefaultValuesInSingleValuedDiscrete'", - "x-discriminator-value": "multipleDefaultValuesInSingleValuedDiscrete", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "The name matches the reverse name of a record link group targeting this table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExistsAsReverse'", - "x-discriminator-value": "nameAlreadyExistsAsReverse", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadyExistsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "parentEntityType": { - "$ref": "#/components/schemas/GsaEntityType" - } - } - } - ], - "additionalProperties": false, - "description": "Database Entity with name already exists.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExists'", - "x-discriminator-value": "nameAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaNameAlreadySpecifiedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Name has been specified more than once in the request.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadySpecified'", - "x-discriminator-value": "nameAlreadySpecified", - "x-discriminator-name": "reason" - }, - "GsaNameMissingCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency must have a name.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameMissing'", - "x-discriminator-value": "nameMissing", - "x-discriminator-name": "reason" - }, - "GsaNameNotProvidedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Entity must have a name.\r\n\r\nThis extends: [GsaNamedEntityErrorDetail](#model-GsaNamedEntityErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameNotProvided'", - "x-discriminator-value": "nameNotProvided", - "x-discriminator-name": "reason" - }, - "GsaNameSameAsReverseNameRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Record link group name and reverse name cannot be the same.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameSameAsReverseName'", - "x-discriminator-value": "nameSameAsReverseName", - "x-discriminator-name": "reason" - }, - "GsaNameWhitespaceCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Currency name must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameWhitespace'", - "x-discriminator-value": "nameWhitespace", - "x-discriminator-name": "reason" - }, - "GsaNameWhitespaceParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Parameter value names must not contain leading or trailing whitespace.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameWhitespace'", - "x-discriminator-value": "nameWhitespace", - "x-discriminator-name": "reason" - }, - "GsaNamedCriterion": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCriterion" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "innerCriterion": { - "$ref": "#/components/schemas/GsaCriterion" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'namedCriterion'", - "x-discriminator-value": "namedCriterion", - "x-discriminator-name": "type" - }, - "GsaNamedEntityAccessControlCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" - }, - "GsaNamedEntityAttributeErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAttributeErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" - }, - "GsaNamedEntityConstantErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaConstantErrorDetail](#model-GsaConstantErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" - }, - "GsaNamedEntityErrorDetail": { - "required": [ - "entityType", - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaNamedEntityErrorReason" - }, - "entityType": { - "$ref": "#/components/schemas/GsaEntityType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEntityAlreadyExistsErrorDetail](#model-GsaEntityAlreadyExistsErrorDetail)\r\n * [GsaNameNotProvidedErrorDetail](#model-GsaNameNotProvidedErrorDetail)\r\n * [GsaNameAlreadyExistsErrorDetail](#model-GsaNameAlreadyExistsErrorDetail)\r\n * [GsaNameAlreadySpecifiedErrorDetail](#model-GsaNameAlreadySpecifiedErrorDetail)\r\n * [GsaEntityIdentifierAlreadySpecifiedErrorDetail](#model-GsaEntityIdentifierAlreadySpecifiedErrorDetail)\r\n * [GsaDisplayNameEmptyErrorDetail](#model-GsaDisplayNameEmptyErrorDetail)\r\n * [GsaDisplayNameLanguageNotProvidedErrorDetail](#model-GsaDisplayNameLanguageNotProvidedErrorDetail)\r\n * [GsaDisplayNameLanguageNotSupportedErrorDetail](#model-GsaDisplayNameLanguageNotSupportedErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "entityAlreadyExists": "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", - "nameNotProvided": "#/components/schemas/GsaNameNotProvidedErrorDetail", - "nameAlreadyExists": "#/components/schemas/GsaNameAlreadyExistsErrorDetail", - "nameAlreadySpecified": "#/components/schemas/GsaNameAlreadySpecifiedErrorDetail", - "entityIdentifierAlreadySpecified": "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail", - "displayNameEmpty": "#/components/schemas/GsaDisplayNameEmptyErrorDetail", - "displayNameLanguageNotProvided": "#/components/schemas/GsaDisplayNameLanguageNotProvidedErrorDetail", - "displayNameLanguageNotSupported": "#/components/schemas/GsaDisplayNameLanguageNotSupportedErrorDetail" - } - } - }, - "GsaNamedEntityErrorReason": { - "enum": [ - "entityAlreadyExists", - "entityIdentifierAlreadySpecified", - "nameNotProvided", - "nameAlreadyExists", - "nameAlreadySpecified", - "displayNameEmpty", - "displayNameLanguageNotProvided", - "displayNameLanguageNotSupported" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • entityAlreadyExists: Entity with GUID already exists.
    • \r\n
  • entityIdentifierAlreadySpecified: GUID has been specified more than once in the request.
    • \r\n
  • nameNotProvided: Entity must have a name.
    • \r\n
  • nameAlreadyExists: Database Entity with name already exists.
    • \r\n
  • nameAlreadySpecified: Name has been specified more than once in the request.
    • \r\n
  • displayNameEmpty: Display name cannot be empty. Display names are optional and can be set to null to remove, but cannot be an empty string or white space only.
    • \r\n
  • displayNameLanguageNotProvided: Display name must have a language.
    • \r\n
  • displayNameLanguageNotSupported: Display name language is not supported. Language must be a .NET culture, e.g. \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\"
    • \r\n
\r\n" - }, - "GsaNamedEntityFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" - }, - "GsaNamedEntityFolderErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "type": "string" + }, + "majorMinorVersion": { + "type": "string" } - ], - "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaNamedEntityParameterErrorDetail": { + "GsaMissingArgumentsParameterContentErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterErrorDetail" + "$ref": "#/components/schemas/GsaParameterContentErrorDetail" }, { "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true + "missingArgument": { + "$ref": "#/components/schemas/GsaParameterContentMissingArgument" } } } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", + "description": "MissingArgument must be provided.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingArguments'", + "x-discriminator-value": "missingArguments", "x-discriminator-name": "reason" }, - "GsaNamedEntityParameterValueErrorDetail": { + "GsaMissingParameterGuidAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - }, - "nullable": true - } - } + "type": "object" } ], "additionalProperties": false, - "description": "The parameter value name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", + "description": "All supplied attribute parameters must have parameter GUIDs specified.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'missingParameterGuid'", + "x-discriminator-value": "missingParameterGuid", "x-discriminator-name": "reason" }, - "GsaNamedEntityPermissionErrorDetail": { + "GsaMoveFile": { + "required": [ + "folderGuid" + ], + "type": "object", + "properties": { + "folderGuid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaMoveFolder": { + "required": [ + "parentGuid" + ], + "type": "object", + "properties": { + "parentGuid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaMoveRecordHistory": { + "type": "object", + "properties": { + "newParent": { + "$ref": "#/components/schemas/GsaSlimRecordHistory" + } + }, + "additionalProperties": false + }, + "GsaNameAlreadyExistsErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" }, { - "required": [ - "errors" - ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "name": { + "type": "string", + "nullable": true } } } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", + "description": "Database Entity with name already exists.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameAlreadyExists'", + "x-discriminator-value": "nameAlreadyExists", "x-discriminator-name": "reason" }, - "GsaNamedEntityRecordLinkGroupErrorDetail": { + "GsaNameNotProvidedErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" + "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" }, { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } - } - } + "type": "object" } ], "additionalProperties": false, - "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", + "description": "Entity must have a name.\r\n\r\nThis extends: GsaNamedEntityErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nameNotProvided'", + "x-discriminator-value": "nameNotProvided", "x-discriminator-name": "reason" }, - "GsaNamedEntityTableErrorDetail": { + "GsaNamedCriterion": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaTableErrorDetail" + "$ref": "#/components/schemas/GsaCriterion" }, { - "required": [ - "errors" - ], "type": "object", "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaNamedEntityErrorDetail" - } + "name": { + "type": "string", + "nullable": true + }, + "innerCriterion": { + "$ref": "#/components/schemas/GsaCriterion" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", - "x-discriminator-value": "namedEntity", - "x-discriminator-name": "reason" + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'namedCriterion'", + "x-discriminator-value": "namedCriterion", + "x-discriminator-name": "type" }, - "GsaNamedEntityUnitErrorDetail": { + "GsaNamedEntityAttributeErrorDetail": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaUnitErrorDetail" + "$ref": "#/components/schemas/GsaAttributeErrorDetail" }, { "type": "object", @@ -106082,10 +78423,50 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", + "description": "The name or GUID is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'namedEntity'", "x-discriminator-value": "namedEntity", "x-discriminator-name": "reason" }, + "GsaNamedEntityErrorDetail": { + "required": [ + "message", + "reason" + ], + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "reason": { + "$ref": "#/components/schemas/GsaNamedEntityErrorReason" + }, + "entityTypeName": { + "type": "string", + "description": "e.g. 'Attribute', 'Meta-attribute'", + "nullable": true + } + }, + "additionalProperties": false, + "description": "\r\n\r\nThis is one of: \r\n * GsaEntityAlreadyExistsErrorDetail\r\n * GsaNameNotProvidedErrorDetail\r\n * GsaNameAlreadyExistsErrorDetail\r\n * GsaEntityIdentifierAlreadySpecifiedErrorDetail", + "discriminator": { + "propertyName": "reason", + "mapping": { + "entityAlreadyExists": "#/components/schemas/GsaEntityAlreadyExistsErrorDetail", + "nameNotProvided": "#/components/schemas/GsaNameNotProvidedErrorDetail", + "nameAlreadyExists": "#/components/schemas/GsaNameAlreadyExistsErrorDetail", + "entityIdentifierAlreadySpecified": "#/components/schemas/GsaEntityIdentifierAlreadySpecifiedErrorDetail" + } + } + }, + "GsaNamedEntityErrorReason": { + "enum": [ + "entityAlreadyExists", + "entityIdentifierAlreadySpecified", + "nameNotProvided", + "nameAlreadyExists" + ], + "type": "string" + }, "GsaNewLayoutAssociationChainItem": { "type": "object", "allOf": [ @@ -106112,7 +78493,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'associationChain'", "x-discriminator-value": "associationChain", "x-discriminator-name": "itemType" }, @@ -106178,7 +78559,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", "x-discriminator-value": "attribute", "x-discriminator-name": "itemType" }, @@ -106212,7 +78593,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'crossDatabaseLink'", "x-discriminator-value": "crossDatabaseLink", "x-discriminator-name": "itemType" }, @@ -106231,7 +78612,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNewLayoutAttributeItem](#model-GsaNewLayoutAttributeItem)\r\n * [GsaNewLayoutRecordLinkItem](#model-GsaNewLayoutRecordLinkItem)\r\n * [GsaNewLayoutSmartLinkItem](#model-GsaNewLayoutSmartLinkItem)\r\n * [GsaNewLayoutCrossDatabaseLinkItem](#model-GsaNewLayoutCrossDatabaseLinkItem)\r\n * [GsaNewLayoutAssociationChainItem](#model-GsaNewLayoutAssociationChainItem)", + "description": "\r\n\r\nThis is one of: \r\n * GsaNewLayoutAttributeItem\r\n * GsaNewLayoutRecordLinkItem\r\n * GsaNewLayoutSmartLinkItem\r\n * GsaNewLayoutCrossDatabaseLinkItem\r\n * GsaNewLayoutAssociationChainItem", "discriminator": { "propertyName": "itemType", "mapping": { @@ -106279,7 +78660,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", "x-discriminator-value": "recordLink", "x-discriminator-name": "itemType" }, @@ -106307,45 +78688,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaNewLayoutItem](#model-GsaNewLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", + "description": "\r\n\r\nThis extends: GsaNewLayoutItem\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", "x-discriminator-value": "smartLink", "x-discriminator-name": "itemType" }, - "GsaNoAttributePairsSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Smart record link group must have at least one attribute pair set.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noAttributePairs'", - "x-discriminator-value": "noAttributePairs", - "x-discriminator-name": "reason" - }, - "GsaNoDataFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object", - "properties": { - "isConfiguration": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "The File is invalid as it has no data/Configuration must have a value.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noData'", - "x-discriminator-value": "noData", - "x-discriminator-name": "reason" - }, "GsaNoExpressionsMathsFunctionalErrorDetail": { "type": "object", "allOf": [ @@ -106357,165 +78703,10 @@ } ], "additionalProperties": false, - "description": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noExpressions'", + "description": "Maths functional attribute must have at least one expression or have 'allow anonymous expressions' set to true.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noExpressions'", "x-discriminator-value": "noExpressions", "x-discriminator-name": "reason" }, - "GsaNoFileFileErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "No File found in the Form data.\r\n\r\nThis extends: [GsaFileErrorDetail](#model-GsaFileErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noFile'", - "x-discriminator-value": "noFile", - "x-discriminator-name": "reason" - }, - "GsaNoParameterValuesParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "No parameter values provided. At least one parameter value is required.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noParameterValues'", - "x-discriminator-value": "noParameterValues", - "x-discriminator-name": "reason" - }, - "GsaNoPermissionsPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Permission categories must have at least one permission.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noPermissions'", - "x-discriminator-value": "noPermissions", - "x-discriminator-name": "reason" - }, - "GsaNoSuchAttributeSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "attributeGuid", - "databaseKey", - "tableGuid" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "attributeGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Attribute not found.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchAttribute'", - "x-discriminator-value": "noSuchAttribute", - "x-discriminator-name": "reason" - }, - "GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "type": "object", - "properties": { - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "One or more permission categories specified for update could not be found.\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchCategories'", - "x-discriminator-value": "noSuchCategories", - "x-discriminator-name": "reason" - }, - "GsaNoSuchCategoryAccessControlErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - { - "required": [ - "categoryGuid" - ], - "type": "object", - "properties": { - "categoryGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "The permission category specified does not exist.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchCategory'", - "x-discriminator-value": "noSuchCategory", - "x-discriminator-name": "reason" - }, - "GsaNoSuchEntityAccessControlCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlCategoryErrorDetail" - }, - { - "required": [ - "entityType", - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "entityType": { - "$ref": "#/components/schemas/GsaAccessControlCategoryNoSuchEntityType" - } - } - } - ], - "additionalProperties": false, - "description": "Could not find the entity with the given GUID.\r\n\r\nThis extends: [GsaAccessControlCategoryErrorDetail](#model-GsaAccessControlCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", - "x-discriminator-value": "noSuchEntity", - "x-discriminator-name": "reason" - }, "GsaNoSuchEntityAttributeErrorDetail": { "type": "object", "allOf": [ @@ -106540,7 +78731,7 @@ } ], "additionalProperties": false, - "description": "Could not find the entityType with the given GUID.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", + "description": "Could not find the entityType with the given GUID.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchEntity'", "x-discriminator-value": "noSuchEntity", "x-discriminator-name": "reason" }, @@ -106572,7 +78763,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNoSuchEntity'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNoSuchEntity'", "x-discriminator-value": "tabularColumnNoSuchEntity", "x-discriminator-name": "reason" }, @@ -106605,66 +78796,10 @@ } ], "additionalProperties": false, - "description": "The not found GUIDs do not correspond to existing expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchExpressions'", + "description": "The not found GUIDs do not correspond to existing expressions.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchExpressions'", "x-discriminator-value": "noSuchExpressions", "x-discriminator-name": "reason" }, - "GsaNoSuchNewParentFileMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "folderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "databaseKey": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "A folder with the given GUID does not exist in database.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchNewParent'", - "x-discriminator-value": "noSuchNewParent", - "x-discriminator-name": "reason" - }, - "GsaNoSuchNewParentFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - }, - "folderType": { - "$ref": "#/components/schemas/GsaFolderType" - }, - "databaseKey": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "A folder with the given GUID does not exist in the database.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchNewParent'", - "x-discriminator-value": "noSuchNewParent", - "x-discriminator-name": "reason" - }, "GsaNoSuchParameterValueParameterContentErrorDetail": { "type": "object", "allOf": [ @@ -106690,176 +78825,10 @@ } ], "additionalProperties": false, - "description": "Could not find parameter value for parameter.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchParameterValue'", + "description": "Could not find parameter value for parameter.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchParameterValue'", "x-discriminator-value": "noSuchParameterValue", "x-discriminator-name": "reason" }, - "GsaNoSuchPermissionAccessControlErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - { - "required": [ - "categoryGuid", - "permissionGuid" - ], - "type": "object", - "properties": { - "permissionGuid": { - "type": "string", - "format": "uuid" - }, - "categoryGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "The permission specified does not exist.\r\n\r\nThis extends: [GsaPermissionCategoriesAccessControlErrorDetail](#model-GsaPermissionCategoriesAccessControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchPermission'", - "x-discriminator-value": "noSuchPermission", - "x-discriminator-name": "reason" - }, - "GsaNoSuchPermissionsPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "type": "object", - "properties": { - "missingGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "One or more permissions specified for update could not be found in the category.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchPermissions'", - "x-discriminator-value": "noSuchPermissions", - "x-discriminator-name": "reason" - }, - "GsaNoSuchTargetTableRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "databaseKey", - "tableGuid" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Target table not found.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchTargetTable'", - "x-discriminator-value": "noSuchTargetTable", - "x-discriminator-name": "reason" - }, - "GsaNoSuchUnitConstantErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaConstantErrorDetail" - }, - { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Could not find the unit with the given GUID.\r\n\r\nThis extends: [GsaConstantErrorDetail](#model-GsaConstantErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", - "x-discriminator-name": "reason" - }, - "GsaNoSuchUnitParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Could not find the unit with the given GUID.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", - "x-discriminator-name": "reason" - }, - "GsaNoSuchUnitSystemUnitEquivalentErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnitSystem'", - "x-discriminator-value": "noSuchUnitSystem", - "x-discriminator-name": "reason" - }, - "GsaNoSuchUnitUnitEquivalentErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquivalentErrorDetail](#model-GsaUnitEquivalentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'noSuchUnit'", - "x-discriminator-value": "noSuchUnit", - "x-discriminator-name": "reason" - }, "GsaNoValueExistsGraphValue": { "type": "object", "allOf": [ @@ -106871,7 +78840,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'noValueExists'", + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'noValueExists'", "x-discriminator-value": "noValueExists", "x-discriminator-name": "graphValueType" }, @@ -106886,33 +78855,10 @@ } ], "additionalProperties": false, - "description": "Used to return no values.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'none'", + "description": "Used to return no values.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'none'", "x-discriminator-value": "none", "x-discriminator-name": "filterOn" }, - "GsaNonCustomStandardNameCannotBeChangedErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "standardName" - ], - "type": "object", - "properties": { - "standardName": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'nonCustomStandardNameCannotBeChanged'", - "x-discriminator-value": "nonCustomStandardNameCannotBeChanged", - "x-discriminator-name": "reason" - }, "GsaNotApplicableDatum": { "type": "object", "allOf": [ @@ -106924,7 +78870,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatum](#model-GsaDatum)\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", + "description": "\r\n\r\nThis extends: GsaDatum\r\n\r\nThe value of discriminator property ('notApplicable') must be equal to 'notApplicable'", "x-discriminator-value": "notApplicable", "x-discriminator-name": "notApplicable" }, @@ -106944,7 +78890,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notTheLatestVersion'", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notTheLatestVersion'", "x-discriminator-value": "notTheLatestVersion", "x-discriminator-name": "reason" }, @@ -106959,33 +78905,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaVersionControlErrorDetail](#model-GsaVersionControlErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notVersioned'", + "description": "\r\n\r\nThis extends: GsaVersionControlErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'notVersioned'", "x-discriminator-value": "notVersioned", "x-discriminator-name": "reason" }, - "GsaNumberParsingUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "required": [ - "invalidNumber" - ], - "type": "object", - "properties": { - "invalidNumber": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'numberParsing'", - "x-discriminator-value": "numberParsing", - "x-discriminator-name": "reason" - }, "GsaNumericGraphParameterValue": { "type": "object", "allOf": [ @@ -107006,7 +78929,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphParameterValue](#model-GsaGraphParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaGraphParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "parameterType" }, @@ -107047,7 +78970,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameter](#model-GsaParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -107079,7 +79002,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterConstraint](#model-GsaParameterConstraint)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaParameterConstraint\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -107104,7 +79027,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterContent](#model-GsaParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -107135,7 +79058,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterDataValue](#model-GsaParameterDataValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaParameterDataValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "parameterType" }, @@ -107163,25 +79086,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaParameterValue](#model-GsaParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, - "GsaNumericRestrictedInterpolationParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Numeric restricted parameters cannot have interpolation type other than 'None'.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'numericRestrictedInterpolation'", - "x-discriminator-value": "numericRestrictedInterpolation", - "x-discriminator-name": "reason" - }, "GsaObjectIdentifier": { "type": "object", "properties": { @@ -107206,54 +79114,6 @@ "additionalProperties": false, "description": "Properties that identify an object within the MI system.\r\n \r\nAn Granta.Server.Api.ObjectIdentifier created by MI will always contain values for all three\r\nproperties. An Granta.Server.Api.ObjectIdentifier created by a client need not contain values for\r\nall three properties, and is allowed to contain values or combinations of values that do\r\nnot correspond to an existing object in MI (in which case the Granta.Server.Api.ObjectIdentifier\r\nwill be resolved against MI objects first by GUID, and then by name, and finally by identity,\r\ntaking the first match and ignoring subsequent fields." }, - "GsaPaginatedItemType": { - "enum": [ - "xyChartTemplate", - "activityLog" - ], - "type": "string" - }, - "GsaPaginatedResponseOf": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTItem" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaXYChartTemplatesInfo](#model-GsaXYChartTemplatesInfo)\r\n * [GsaActivityLogEntriesInfo](#model-GsaActivityLogEntriesInfo)", - "discriminator": { - "propertyName": "itemType", - "mapping": { - "xyChartTemplate": "#/components/schemas/GsaXYChartTemplatesInfo", - "activityLog": "#/components/schemas/GsaActivityLogEntriesInfo" - } - } - }, - "GsaPaginationLinks": { - "type": "object", - "properties": { - "next": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaPagingOptions": { "type": "object", "properties": { @@ -107291,6 +79151,10 @@ "type": { "$ref": "#/components/schemas/GsaParameterType" }, + "helpPath": { + "type": "string", + "nullable": true + }, "defaultParameterValueGuid": { "type": "string", "format": "uuid" @@ -107300,8 +79164,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -107312,7 +79175,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameter](#model-GsaDiscreteParameter)\r\n * [GsaNumericParameter](#model-GsaNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameter\r\n * GsaNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -107336,7 +79199,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterNameConstraint](#model-GsaDiscreteParameterNameConstraint)\r\n * [GsaDiscreteParameterValueConstraint](#model-GsaDiscreteParameterValueConstraint)\r\n * [GsaNumericParameterConstraint](#model-GsaNumericParameterConstraint)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterNameConstraint\r\n * GsaDiscreteParameterValueConstraint\r\n * GsaNumericParameterConstraint", "discriminator": { "propertyName": "type", "mapping": { @@ -107369,7 +79232,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterContent](#model-GsaDiscreteParameterContent)\r\n * [GsaNumericParameterContent](#model-GsaNumericParameterContent)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterContent\r\n * GsaNumericParameterContent", "discriminator": { "propertyName": "type", "mapping": { @@ -107399,7 +79262,7 @@ } ], "additionalProperties": false, - "description": "No duplicate parameter GUIDs allowed in parameter contents.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentDuplicateGuids'", + "description": "No duplicate parameter GUIDs allowed in parameter contents.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentDuplicateGuids'", "x-discriminator-value": "parameterContentDuplicateGuids", "x-discriminator-name": "reason" }, @@ -107418,7 +79281,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaParameterTypeParameterContentErrorDetail](#model-GsaParameterTypeParameterContentErrorDetail)\r\n * [GsaMissingArgumentsParameterContentErrorDetail](#model-GsaMissingArgumentsParameterContentErrorDetail)\r\n * [GsaNoSuchParameterValueParameterContentErrorDetail](#model-GsaNoSuchParameterValueParameterContentErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaParameterTypeParameterContentErrorDetail\r\n * GsaMissingArgumentsParameterContentErrorDetail\r\n * GsaNoSuchParameterValueParameterContentErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -107434,8 +79297,7 @@ "missingArguments", "noSuchParameterValue" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • parameterType: Requested parameter content type does not align with its actual parameter type.
    • \r\n
  • missingArguments: MissingArgument must be provided.
    • \r\n
  • noSuchParameterValue: Could not find parameter value for parameter.
    • \r\n
\r\n" + "type": "string" }, "GsaParameterContentMathsFunctionalErrorDetail": { "type": "object", @@ -107461,7 +79323,7 @@ } ], "additionalProperties": false, - "description": "ParameterContent is not valid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContent'", + "description": "ParameterContent is not valid.\r\nSee \"errors\" for details.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContent'", "x-discriminator-value": "parameterContent", "x-discriminator-name": "reason" }, @@ -107501,34 +79363,10 @@ } ], "additionalProperties": false, - "description": "Parameters in parameter contents must be from this attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: [GsaMathsFunctionalErrorDetail](#model-GsaMathsFunctionalErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentUnknownParameters'", + "description": "Parameters in parameter contents must be from this attribute's parameters.\r\nMaths functional attributes only.\r\n\r\nThis extends: GsaMathsFunctionalErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterContentUnknownParameters'", "x-discriminator-value": "parameterContentUnknownParameters", "x-discriminator-name": "reason" }, - "GsaParameterCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaParameterDataValue": { "required": [ "parameterType" @@ -107540,7 +79378,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterDataValue](#model-GsaDiscreteParameterDataValue)\r\n * [GsaNumericParameterDataValue](#model-GsaNumericParameterDataValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterDataValue\r\n * GsaNumericParameterDataValue", "discriminator": { "propertyName": "parameterType", "mapping": { @@ -107550,9 +79388,6 @@ } }, "GsaParameterDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -107560,12 +79395,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -107577,54 +79407,6 @@ }, "additionalProperties": false }, - "GsaParameterErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaParameterErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDefaultParameterValueGuidParameterErrorDetail](#model-GsaDefaultParameterValueGuidParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexParameterErrorDetail](#model-GsaDefaultParameterValueIndexParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail](#model-GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail)\r\n * [GsaDefaultParameterValueIndexAndGuidParameterErrorDetail](#model-GsaDefaultParameterValueIndexAndGuidParameterErrorDetail)\r\n * [GsaNamedEntityParameterErrorDetail](#model-GsaNamedEntityParameterErrorDetail)\r\n * [GsaNoParameterValuesParameterErrorDetail](#model-GsaNoParameterValuesParameterErrorDetail)\r\n * [GsaNoSuchUnitParameterErrorDetail](#model-GsaNoSuchUnitParameterErrorDetail)\r\n * [GsaNumericRestrictedInterpolationParameterErrorDetail](#model-GsaNumericRestrictedInterpolationParameterErrorDetail)\r\n * [GsaParameterTypeParameterErrorDetail](#model-GsaParameterTypeParameterErrorDetail)\r\n * [GsaParameterValueParameterErrorDetail](#model-GsaParameterValueParameterErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "defaultParameterValueGuid": "#/components/schemas/GsaDefaultParameterValueGuidParameterErrorDetail", - "defaultParameterValueIndex": "#/components/schemas/GsaDefaultParameterValueIndexParameterErrorDetail", - "defaultParameterValueIndexWithoutValues": "#/components/schemas/GsaDefaultParameterValueIndexWithoutValuesParameterErrorDetail", - "defaultParameterValueIndexAndGuid": "#/components/schemas/GsaDefaultParameterValueIndexAndGuidParameterErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityParameterErrorDetail", - "noParameterValues": "#/components/schemas/GsaNoParameterValuesParameterErrorDetail", - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitParameterErrorDetail", - "numericRestrictedInterpolation": "#/components/schemas/GsaNumericRestrictedInterpolationParameterErrorDetail", - "parameterType": "#/components/schemas/GsaParameterTypeParameterErrorDetail", - "parameterValue": "#/components/schemas/GsaParameterValueParameterErrorDetail" - } - } - }, - "GsaParameterErrorReason": { - "enum": [ - "defaultParameterValueGuid", - "defaultParameterValueIndex", - "defaultParameterValueIndexAndGuid", - "defaultParameterValueIndexWithoutValues", - "namedEntity", - "noParameterValues", - "noSuchUnit", - "numericRestrictedInterpolation", - "parameterType", - "parameterValue" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • defaultParameterValueGuid: Default parameter value GUID does not match any parameter value.
    • \r\n
  • defaultParameterValueIndex: Default parameter value index out of range.
    • \r\n
  • defaultParameterValueIndexAndGuid: Default parameter value can be specified by either index or GUID, not both.
    • \r\n
  • defaultParameterValueIndexWithoutValues: Default parameter value index can only be used when values are being updated. Use DefaultParameterValueGuid when values are not being updated.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noParameterValues: No parameter values provided. At least one parameter value is required.
    • \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
  • numericRestrictedInterpolation: Numeric restricted parameters cannot have interpolation type other than 'None'.
    • \r\n
  • parameterType: When updating an existing parameter, parameter type must match.
    • \r\n
  • parameterValue: Parameter value is not valid.
    • \r\n
\r\n" - }, "GsaParameterInfo": { "type": "object", "properties": { @@ -107736,78 +79518,10 @@ } ], "additionalProperties": false, - "description": "Requested parameter content type does not align with its actual parameter type.\r\n\r\nThis extends: [GsaParameterContentErrorDetail](#model-GsaParameterContentErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", - "x-discriminator-value": "parameterType", - "x-discriminator-name": "reason" - }, - "GsaParameterTypeParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "newParameterType": { - "$ref": "#/components/schemas/GsaParameterType" - } - } - } - ], - "additionalProperties": false, - "description": "When updating an existing parameter, parameter type must match.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", + "description": "Requested parameter content type does not align with its actual parameter type.\r\n\r\nThis extends: GsaParameterContentErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterType'", "x-discriminator-value": "parameterType", "x-discriminator-name": "reason" }, - "GsaParameterUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaParameterUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'parameter'", - "x-discriminator-value": "parameter", - "x-discriminator-name": "referencedByType" - }, "GsaParameterValue": { "required": [ "guid", @@ -107824,7 +79538,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteParameterValue](#model-GsaDiscreteParameterValue)\r\n * [GsaNumericParameterValue](#model-GsaNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDiscreteParameterValue\r\n * GsaNumericParameterValue", "discriminator": { "propertyName": "type", "mapping": { @@ -107833,38 +79547,7 @@ } } }, - "GsaParameterValueCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaParameterValueDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -107872,12 +79555,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -107889,70 +79567,6 @@ }, "additionalProperties": false }, - "GsaParameterValueErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaParameterValueErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaInUseParameterValueErrorDetail](#model-GsaInUseParameterValueErrorDetail)\r\n * [GsaLogScaleNegativeParameterValueErrorDetail](#model-GsaLogScaleNegativeParameterValueErrorDetail)\r\n * [GsaNamedEntityParameterValueErrorDetail](#model-GsaNamedEntityParameterValueErrorDetail)\r\n * [GsaNameWhitespaceParameterValueErrorDetail](#model-GsaNameWhitespaceParameterValueErrorDetail)\r\n * [GsaParameterValueTypeParameterValueErrorDetail](#model-GsaParameterValueTypeParameterValueErrorDetail)\r\n * [GsaValueNotProvidedParameterValueErrorDetail](#model-GsaValueNotProvidedParameterValueErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "inUse": "#/components/schemas/GsaInUseParameterValueErrorDetail", - "logScaleNegative": "#/components/schemas/GsaLogScaleNegativeParameterValueErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityParameterValueErrorDetail", - "nameWhitespace": "#/components/schemas/GsaNameWhitespaceParameterValueErrorDetail", - "parameterValueType": "#/components/schemas/GsaParameterValueTypeParameterValueErrorDetail", - "valueNotProvided": "#/components/schemas/GsaValueNotProvidedParameterValueErrorDetail" - } - } - }, - "GsaParameterValueErrorReason": { - "enum": [ - "inUse", - "logScaleNegative", - "namedEntity", - "nameWhitespace", - "parameterValueType", - "valueNotProvided" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • inUse: The parameter value is being used.
    • \r\n
  • logScaleNegative: For a log-scale parameter, all values must be greater than zero.
    • \r\n
  • namedEntity: The parameter value name or GUID is not valid.
    • \r\n
  • nameWhitespace: Parameter value names must not contain leading or trailing whitespace.
    • \r\n
  • parameterValueType: All parameter values should match the type (discrete or numeric) of the parameter.
    • \r\n
  • valueNotProvided: Numeric parameter values must have a value.
    • \r\n
\r\n" - }, - "GsaParameterValueParameterErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterErrorDetail" - }, - { - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Parameter value is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaParameterErrorDetail](#model-GsaParameterErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterValue'", - "x-discriminator-value": "parameterValue", - "x-discriminator-name": "reason" - }, "GsaParameterValueType": { "enum": [ "discrete", @@ -107960,62 +79574,6 @@ ], "type": "string" }, - "GsaParameterValueTypeParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "parameterType": { - "$ref": "#/components/schemas/GsaParameterType" - } - } - } - ], - "additionalProperties": false, - "description": "All parameter values should match the type (discrete or numeric) of the parameter.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'parameterValueType'", - "x-discriminator-value": "parameterValueType", - "x-discriminator-name": "reason" - }, - "GsaParameterValueUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "parameterValueGuid": { - "type": "string", - "format": "uuid" - }, - "parameterGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaParameterValueUsedByType": { - "enum": [ - "functionalDataDefault", - "multiValuedPointData" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • functionalDataDefault: The parameter value is used as the default parameter value on one or more functional datums.
    • \r\n
  • multiValuedPointData: The discrete parameter value is used by multi-valued point data.
    • \r\n
\r\n" - }, "GsaParameterWithDataValue": { "required": [ "parameter", @@ -108080,97 +79638,6 @@ }, "additionalProperties": false }, - "GsaPermissionAccessControl": { - "required": [ - "canRead", - "canWrite", - "permission" - ], - "type": "object", - "properties": { - "permission": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "canRead": { - "type": "boolean" - }, - "canWrite": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaPermissionBasedAccessControlInfo": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaAccessControlInfo" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAccessControlInfo](#model-GsaAccessControlInfo)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'permissionBased'", - "x-discriminator-value": "permissionBased", - "x-discriminator-name": "mode" - }, - "GsaPermissionCategoriesAccessControlErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchCategoryAccessControlErrorDetail](#model-GsaNoSuchCategoryAccessControlErrorDetail)\r\n * [GsaNoSuchPermissionAccessControlErrorDetail](#model-GsaNoSuchPermissionAccessControlErrorDetail)\r\n * [GsaDuplicateCategoryGuidsAccessControlErrorDetail](#model-GsaDuplicateCategoryGuidsAccessControlErrorDetail)\r\n * [GsaDuplicatePermissionGuidsAccessControlErrorDetail](#model-GsaDuplicatePermissionGuidsAccessControlErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchCategory": "#/components/schemas/GsaNoSuchCategoryAccessControlErrorDetail", - "noSuchPermission": "#/components/schemas/GsaNoSuchPermissionAccessControlErrorDetail", - "duplicateCategoryGuids": "#/components/schemas/GsaDuplicateCategoryGuidsAccessControlErrorDetail", - "duplicatePermissionGuids": "#/components/schemas/GsaDuplicatePermissionGuidsAccessControlErrorDetail" - } - } - }, - "GsaPermissionCategoriesAccessControlErrorReason": { - "enum": [ - "noSuchPermission", - "noSuchCategory", - "duplicateCategoryGuids", - "duplicatePermissionGuids" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchPermission: The permission specified does not exist.
    • \r\n
  • noSuchCategory: The permission category specified does not exist.
    • \r\n
  • duplicateCategoryGuids: Duplicate permission category GUIDs were specified in the request.
    • \r\n
  • duplicatePermissionGuids: Duplicate permission GUIDs were specified within a category in the request.
    • \r\n
\r\n" - }, - "GsaPermissionCategoriesAccessControlUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoriesAccessControlErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaPermissionCategoriesInfo": { "required": [ "categories" @@ -108180,7 +79647,7 @@ "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermissionCategory" + "$ref": "#/components/schemas/GsaSlimPermissionCategory" } } }, @@ -108197,331 +79664,15 @@ "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermission" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryAccessControl": { - "required": [ - "category", - "permissionAccessControls" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "permissionAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionAccessControl" + "$ref": "#/components/schemas/GsaSlimNamedEntity" } - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryAccessControlInfo": { - "type": "object", - "properties": { - "categoryAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryAccessControl" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityPermissionErrorDetail](#model-GsaNamedEntityPermissionErrorDetail)\r\n * [GsaNoPermissionsPermissionCategoryErrorDetail](#model-GsaNoPermissionsPermissionCategoryErrorDetail)\r\n * [GsaTooManyPermissionsPermissionCategoryErrorDetail](#model-GsaTooManyPermissionsPermissionCategoryErrorDetail)\r\n * [GsaDuplicatePermissionsPermissionCategoryErrorDetail](#model-GsaDuplicatePermissionsPermissionCategoryErrorDetail)\r\n * [GsaPermissionPermissionCategoryErrorDetail](#model-GsaPermissionPermissionCategoryErrorDetail)\r\n * [GsaNoSuchPermissionsPermissionCategoryErrorDetail](#model-GsaNoSuchPermissionsPermissionCategoryErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "noPermissions": "#/components/schemas/GsaNoPermissionsPermissionCategoryErrorDetail", - "tooManyPermissions": "#/components/schemas/GsaTooManyPermissionsPermissionCategoryErrorDetail", - "duplicatePermissions": "#/components/schemas/GsaDuplicatePermissionsPermissionCategoryErrorDetail", - "permission": "#/components/schemas/GsaPermissionPermissionCategoryErrorDetail", - "noSuchPermissions": "#/components/schemas/GsaNoSuchPermissionsPermissionCategoryErrorDetail" - } - } - }, - "GsaPermissionCategoryErrorReason": { - "enum": [ - "namedEntity", - "noPermissions", - "tooManyPermissions", - "duplicatePermissions", - "permission", - "noSuchPermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • noPermissions: Permission categories must have at least one permission.
    • \r\n
  • tooManyPermissions: The new permissions cannot be added, there are not enough permissions available. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
  • duplicatePermissions: Duplicate permissions were specified, either by name or GUID.
    • \r\n
  • permission: A permission in the category is not valid.
    • \r\n
  • noSuchPermissions: One or more permissions specified for update do not exist in the category.
    • \r\n
\r\n" - }, - "GsaPermissionCategoryReplaceException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCategoryUpdateException": { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" }, "name": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionDeletionErrorDetail": { - "required": [ - "message" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionDeletionErrorReason" - } - }, - "additionalProperties": false - }, - "GsaPermissionDeletionErrorReason": { - "enum": [ - "categoryMustHavePermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • categoryMustHavePermissions: Permission categories must have at least one permission.
    • \r\n
\r\n" - }, - "GsaPermissionDeletionException": { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionDeletionErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaPermissionErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaPermissionErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityPermissionErrorDetail](#model-GsaNamedEntityPermissionErrorDetail)\r\n * [GsaRoleNotProvidedPermissionErrorDetail](#model-GsaRoleNotProvidedPermissionErrorDetail)\r\n * [GsaMaxPermissionsReachedPermissionErrorDetail](#model-GsaMaxPermissionsReachedPermissionErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityPermissionErrorDetail", - "roleNotProvided": "#/components/schemas/GsaRoleNotProvidedPermissionErrorDetail", - "maxPermissionsReached": "#/components/schemas/GsaMaxPermissionsReachedPermissionErrorDetail" - } - } - }, - "GsaPermissionErrorReason": { - "enum": [ - "namedEntity", - "roleNotProvided", - "maxPermissionsReached" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • roleNotProvided: Role must be provided, and cannot be empty or whitespace.
    • \r\n
  • maxPermissionsReached: There are no more permissions available, the maximum number has been reached. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
\r\n" - }, - "GsaPermissionPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The permission is not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'permission'", - "x-discriminator-value": "permission", - "x-discriminator-name": "reason" - }, - "GsaPermissionUpdateException": { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, "guid": { "type": "string", "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - "nullable": true } }, "additionalProperties": false @@ -108535,7 +79686,7 @@ "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaPermission" + "$ref": "#/components/schemas/GsaSlimPermission" } } }, @@ -108552,7 +79703,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -108575,7 +79726,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "datumType" }, @@ -108590,7 +79741,7 @@ } ], "additionalProperties": false, - "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "picture: Criterion for matching records where picture data exists.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -108605,7 +79756,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -108632,7 +79783,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "datumType" }, @@ -108647,7 +79798,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with at least one value for the attribute.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with at least one value for the attribute.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -108680,35 +79831,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", - "x-discriminator-value": "point", - "x-discriminator-name": "type" - }, - "GsaPointChartData": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaChartData" - }, - { - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "estimated": { - "type": "boolean" - }, - "parameterValues": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -108764,7 +79887,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "datumType" }, @@ -108793,7 +79916,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching records where the point data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Criterion for matching records where the point data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -108808,7 +79931,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -108835,7 +79958,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointFixedWidthHistogram'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointFixedWidthHistogram'", "x-discriminator-value": "pointFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -108855,7 +79978,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'pointHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'pointHistogram'", "x-discriminator-value": "pointHistogram", "x-discriminator-name": "datumType" }, @@ -108876,7 +79999,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointHistogram'", + "description": "Criterion for aggregating data within a point attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'pointHistogram'", "x-discriminator-value": "pointHistogram", "x-discriminator-name": "type" }, @@ -108891,7 +80014,7 @@ } ], "additionalProperties": false, - "description": "Only attributes marked as multi-valued can be parameterized.\r\nPoint attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'pointParametersRequiresMultiValued'", + "description": "Only attributes marked as multi-valued can be parameterized.\r\nPoint attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'pointParametersRequiresMultiValued'", "x-discriminator-value": "pointParametersRequiresMultiValued", "x-discriminator-name": "reason" }, @@ -109038,7 +80161,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatedByUserProperty](#model-GsaCreatedByUserProperty)\r\n * [GsaCreatedDateProperty](#model-GsaCreatedDateProperty)\r\n * [GsaDatabaseKeyProperty](#model-GsaDatabaseKeyProperty)\r\n * [GsaFullNameProperty](#model-GsaFullNameProperty)\r\n * [GsaLastModifiedDateProperty](#model-GsaLastModifiedDateProperty)\r\n * [GsaLastModifiedByUserProperty](#model-GsaLastModifiedByUserProperty)\r\n * [GsaRecordColorProperty](#model-GsaRecordColorProperty)\r\n * [GsaRecordGuidProperty](#model-GsaRecordGuidProperty)\r\n * [GsaRecordHistoryGuidProperty](#model-GsaRecordHistoryGuidProperty)\r\n * [GsaRecordTypeProperty](#model-GsaRecordTypeProperty)\r\n * [GsaReleasedDateProperty](#model-GsaReleasedDateProperty)\r\n * [GsaShortNameProperty](#model-GsaShortNameProperty)\r\n * [GsaTableGuidProperty](#model-GsaTableGuidProperty)\r\n * [GsaTableIdentityProperty](#model-GsaTableIdentityProperty)\r\n * [GsaTableNameProperty](#model-GsaTableNameProperty)\r\n * [GsaVersionNumberProperty](#model-GsaVersionNumberProperty)\r\n * [GsaVersionStateProperty](#model-GsaVersionStateProperty)", + "description": "\r\n\r\nThis is one of: \r\n * GsaCreatedByUserProperty\r\n * GsaCreatedDateProperty\r\n * GsaDatabaseKeyProperty\r\n * GsaFullNameProperty\r\n * GsaLastModifiedDateProperty\r\n * GsaLastModifiedByUserProperty\r\n * GsaRecordColorProperty\r\n * GsaRecordGuidProperty\r\n * GsaRecordHistoryGuidProperty\r\n * GsaRecordTypeProperty\r\n * GsaReleasedDateProperty\r\n * GsaShortNameProperty\r\n * GsaTableGuidProperty\r\n * GsaTableIdentityProperty\r\n * GsaTableNameProperty\r\n * GsaVersionNumberProperty\r\n * GsaVersionStateProperty", "discriminator": { "propertyName": "propertyName", "mapping": { @@ -109062,166 +80185,9 @@ } } }, - "GsaPutLayoutItem": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n * [GsaUpdatePutLayoutItem](#model-GsaUpdatePutLayoutItem)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutLayoutItem", - "update": "#/components/schemas/GsaUpdatePutLayoutItem" - } - } - }, - "GsaPutPermission": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutPermission](#model-GsaCreatePutPermission)\r\n * [GsaUpdatePutPermission](#model-GsaUpdatePutPermission)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutPermission", - "update": "#/components/schemas/GsaUpdatePutPermission" - } - } - }, - "GsaPutPermissionCategory": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaPutType" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory)\r\n * [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory)", - "discriminator": { - "propertyName": "type", - "mapping": { - "create": "#/components/schemas/GsaCreatePutPermissionCategory", - "update": "#/components/schemas/GsaUpdatePutPermissionCategory" - } - } - }, - "GsaPutType": { - "enum": [ - "create", - "update" - ], - "type": "string" - }, - "GsaQualityDiscreteValue": { - "required": [ - "guid", - "name", - "order" - ], - "type": "object", - "properties": { - "order": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaQualitySystem": { - "required": [ - "guid", - "name", - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/GsaQualitySystemType" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDiscreteQualitySystem](#model-GsaDiscreteQualitySystem)\r\n * [GsaContinuousQualitySystem](#model-GsaContinuousQualitySystem)", - "discriminator": { - "propertyName": "type", - "mapping": { - "discrete": "#/components/schemas/GsaDiscreteQualitySystem", - "continuous": "#/components/schemas/GsaContinuousQualitySystem" - } - } - }, - "GsaQualitySystemGuidErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'qualitySystemGuid'", - "x-discriminator-value": "qualitySystemGuid", - "x-discriminator-name": "reason" - }, - "GsaQualitySystemType": { - "enum": [ - "discrete", - "continuous" - ], - "type": "string" - }, - "GsaQualitySystemsInfo": { - "type": "object", - "properties": { - "qualitySystems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQualitySystem" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQueryAttribute": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "type": { "$ref": "#/components/schemas/GsaAttributeType" }, @@ -109240,19 +80206,12 @@ "type": "boolean", "nullable": true }, - "helpPath": { - "type": "string", - "nullable": true - }, "axisName": { "$ref": "#/components/schemas/GsaQueryAxisName" }, "info": { "$ref": "#/components/schemas/GsaQueryAttributeInfo" }, - "table": { - "$ref": "#/components/schemas/GsaQuerySlimEntity" - }, "unit": { "$ref": "#/components/schemas/GsaQueryUnit" }, @@ -109271,7 +80230,7 @@ "tabularColumns": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaQueryTabularColumn" + "$ref": "#/components/schemas/GsaQuerySlimNamedEntity" }, "nullable": true }, @@ -109337,13 +80296,10 @@ }, "description": "If set, attribute GUID must match any of these GUIDs.", "nullable": true - }, - "discreteType": { - "$ref": "#/components/schemas/GsaQuerySlimNamedEntityFilter" } }, "additionalProperties": false, - "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then attributes must match all of them.\r\n\r\ndiscreteType: If set, attribute must have a discrete type that matches the filter. If the filter has no criteria set, this means the attribute must have any discrete type assigned." + "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then attributes must match all of them." }, "GsaQueryAttributeInfo": { "type": "object", @@ -109379,10 +80335,6 @@ "GsaQueryAttributeProperties": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "type": { "type": "boolean", "nullable": true @@ -109404,19 +80356,12 @@ "description": "For a Granta.Server.Api.AttributeType.FloatFunctional attribute, whether the value for this attribute is ranged.\r\nFor other attribute types, returns null", "nullable": true }, - "helpPath": { - "type": "boolean", - "nullable": true - }, "axisName": { "$ref": "#/components/schemas/GsaQueryAxisNameProperties" }, "info": { "$ref": "#/components/schemas/GsaQueryAttributeInfoProperties" }, - "table": { - "$ref": "#/components/schemas/GsaQuerySlimEntityProperties" - }, "unit": { "$ref": "#/components/schemas/GsaQueryUnitProperties" }, @@ -109433,7 +80378,7 @@ "$ref": "#/components/schemas/GsaQueryTabularAttributeTargetProperties" }, "tabularColumns": { - "$ref": "#/components/schemas/GsaQueryTabularColumnProperties" + "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" }, "attributeParameters": { "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" @@ -109569,10 +80514,6 @@ "GsaQueryDiscreteType": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "discreteValues": { "type": "array", "items": { @@ -109623,10 +80564,6 @@ "GsaQueryDiscreteTypeProperties": { "type": "object", "properties": { - "isProtected": { - "type": "boolean", - "nullable": true - }, "discreteValues": { "$ref": "#/components/schemas/GsaQuerySlimNamedEntityProperties" }, @@ -109676,277 +80613,6 @@ }, "additionalProperties": false }, - "GsaQueryLayout": { - "type": "object", - "properties": { - "sections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutSection" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutFilter": { - "type": "object", - "properties": { - "sections": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionFilter" - } - }, - "additionalProperties": false, - "description": "Optionally filter results.\r\n \r\nIf multiple properties are set, then layouts must match all of them.\r\n\r\nsections: Filter by sections that the layout contains." - }, - "GsaQueryLayoutItem": { - "type": "object", - "properties": { - "underlyingEntityGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "itemType": { - "$ref": "#/components/schemas/GsaLayoutItemType" - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutItemFilter": { - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaLayoutItemType" - }, - "underlyingEntityGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "linkType": { - "$ref": "#/components/schemas/GsaLayoutItemLinkType" - }, - "targetDatabase": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "targetDatabaseVersion": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "targetTable": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "forwards": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "If multiple properties are set, then layout items must match all of them." - }, - "GsaQueryLayoutItemProperties": { - "type": "object", - "properties": { - "underlyingEntityGuid": { - "type": "boolean", - "nullable": true - }, - "itemType": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutProperties": { - "type": "object", - "properties": { - "sections": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionProperties" - }, - "displayNames": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutSection": { - "type": "object", - "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutItem" - }, - "nullable": true - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutSectionFilter": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "sectionItems": { - "$ref": "#/components/schemas/GsaQueryLayoutItemFilter" - } - }, - "additionalProperties": false, - "description": "If multiple properties are set, then layout sections must match all of them.\r\n\r\nsectionItems: Filter by items that the section contains." - }, - "GsaQueryLayoutSectionProperties": { - "type": "object", - "properties": { - "sectionItems": { - "$ref": "#/components/schemas/GsaQueryLayoutItemProperties" - }, - "displayNames": { - "type": "boolean", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, - "GsaQueryLayoutSectionsInfo": { - "required": [ - "layoutSections" - ], - "type": "object", - "properties": { - "layoutSections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayoutSection" - } - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutSectionsRequest": { - "required": [ - "properties" - ], - "type": "object", - "properties": { - "properties": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionProperties" - }, - "filter": { - "$ref": "#/components/schemas/GsaQueryLayoutSectionFilter" - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutsInfo": { - "required": [ - "layouts" - ], - "type": "object", - "properties": { - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaQueryLayout" - } - } - }, - "additionalProperties": false - }, - "GsaQueryLayoutsRequest": { - "required": [ - "properties" - ], - "type": "object", - "properties": { - "properties": { - "$ref": "#/components/schemas/GsaQueryLayoutProperties" - }, - "filter": { - "$ref": "#/components/schemas/GsaQueryLayoutFilter" - } - }, - "additionalProperties": false - }, "GsaQuerySlimDiscreteType": { "type": "object", "properties": { @@ -109985,28 +80651,6 @@ "additionalProperties": false, "description": "Set values to true to include those properties in the query response" }, - "GsaQuerySlimEntity": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQuerySlimEntityProperties": { - "type": "object", - "properties": { - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Set values to true to include those properties in the query response" - }, "GsaQuerySlimNamedEntity": { "type": "object", "properties": { @@ -110022,29 +80666,6 @@ }, "additionalProperties": false }, - "GsaQuerySlimNamedEntityFilter": { - "type": "object", - "properties": { - "name": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If set, entity name must match any of these names.", - "nullable": true - }, - "guid": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "If set, entity GUID must match any of these GUIDs.", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQuerySlimNamedEntityProperties": { "type": "object", "properties": { @@ -110315,56 +80936,6 @@ "additionalProperties": false, "description": "Set values to true to include those properties in the query response" }, - "GsaQueryTabularColumn": { - "type": "object", - "properties": { - "linkedAttributeGuid": { - "type": "string", - "description": "This can only be populated for linked attribute type columns", - "format": "uuid", - "nullable": true - }, - "linkedColumnGuid": { - "type": "string", - "description": "This can only be populated for linked column type columns", - "format": "uuid", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaQueryTabularColumnProperties": { - "type": "object", - "properties": { - "linkedAttributeGuid": { - "type": "boolean", - "nullable": true - }, - "linkedColumnGuid": { - "type": "boolean", - "description": "This can only be populated for linked column type columns", - "nullable": true - }, - "name": { - "type": "boolean", - "nullable": true - }, - "guid": { - "type": "boolean", - "nullable": true - } - }, - "additionalProperties": false - }, "GsaQueryUnit": { "type": "object", "properties": { @@ -110442,7 +81013,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "datumType" }, @@ -110457,7 +81028,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with a value for the attribute.\r\n \r\nAs in MI elsewhere, a range with only one boundary specified is treated like a point, rather than an infinitely large range.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain the minimum and maximum\r\nvalues (in database units), and a count of records with a value for the attribute.\r\n \r\nAs in MI elsewhere, a range with only one boundary specified is treated like a point, rather than an infinitely large range.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -110477,17 +81048,24 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, - "GsaRangeChartData": { + "GsaRangeDatum": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/GsaChartData" + "$ref": "#/components/schemas/GsaApplicableDatum" }, { + "required": [ + "estimated", + "highValue", + "highValueIsInclusive", + "lowValue", + "lowValueIsInclusive" + ], "type": "object", "properties": { "lowValue": { @@ -110498,34 +81076,11 @@ "type": "number", "format": "double" }, - "estimated": { + "lowValueIsInclusive": { "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaChartData](#model-GsaChartData)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", - "x-discriminator-value": "range", - "x-discriminator-name": "type" - }, - "GsaRangeDatum": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaApplicableDatum" - }, - { - "required": [ - "estimated" - ], - "type": "object", - "properties": { - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" }, - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "highValueIsInclusive": { + "type": "boolean" }, "lowValueSignificantFiguresInfo": { "$ref": "#/components/schemas/GsaSignificantFiguresInfo" @@ -110543,7 +81098,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "datumType" }, @@ -110572,7 +81127,7 @@ } ], "additionalProperties": false, - "description": "Criterion for matching records where the range data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Criterion for matching records where the range data is within the given bounds. If one of gte or lte is null, this will be an open ended search.\r\nIf this is a unitted attribute, the search values should be given in terms of the units defined for the attribute in the database/integration schema.\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -110587,27 +81142,10 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, - "GsaRangeEndpoint": { - "required": [ - "inclusiveness", - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "number", - "format": "double" - }, - "inclusiveness": { - "$ref": "#/components/schemas/GsaInclusiveness" - } - }, - "additionalProperties": false - }, "GsaRangeFixedWidthHistogramAggregationDatumCriterion": { "type": "object", "allOf": [ @@ -110631,7 +81169,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeFixedWidthHistogram'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed interval.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeFixedWidthHistogram'", "x-discriminator-value": "rangeFixedWidthHistogram", "x-discriminator-name": "type" }, @@ -110676,7 +81214,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraphValue](#model-GsaGraphValue)\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaGraphValue\r\n\r\nThe value of discriminator property ('graphValueType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "graphValueType" }, @@ -110696,7 +81234,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'rangeHistogram'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'rangeHistogram'", "x-discriminator-value": "rangeHistogram", "x-discriminator-name": "datumType" }, @@ -110717,7 +81255,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeHistogram'", + "description": "Criterion for aggregating data within a range attribute. The returned aggregation will contain a histogram of the data with a fixed number of buckets. The buckets may have variable widths.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'rangeHistogram'", "x-discriminator-value": "rangeHistogram", "x-discriminator-name": "type" }, @@ -110745,7 +81283,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestor'", + "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestor'", "x-discriminator-value": "recordAncestor", "x-discriminator-name": "type" }, @@ -110773,18 +81311,47 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor history GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestorHistory'", + "description": "Criterion that returns records with a specific parent or ancestor. If no ancestor history GUID is provided, either all records under the table or records directly below the table are returned based on the value of directParentOnly.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordAncestorHistory'", "x-discriminator-value": "recordAncestorHistory", "x-discriminator-name": "type" }, - "GsaRecordAndAttributeSelectionType": { - "enum": [ - "Profile", - "AllAttributes", - "AllAttributesAndRecords" + "GsaRecordCapabilities": { + "required": [ + "canDelete", + "canGetModifiableVersion", + "canModify", + "canRelease", + "canWithdraw", + "canWrite" ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • Profile: The original type of selection - attributes and records are retrieved from the selected profile. If no profile is selected, then no attributes or records are selected.
    • \r\n
  • AllAttributes: All attributes in the database are selected.
    • \r\n
  • AllAttributesAndRecords: All attributes and records in the database are selected.
    • \r\n
\r\n" + "type": "object", + "properties": { + "canWrite": { + "type": "boolean", + "description": "True if the current user has write permission for this record version, and is in write mode.\r\nWrite permission is required to edit record properties, and to perform version control actions." + }, + "canModify": { + "type": "boolean", + "description": "True if the current user can modify this record version, e.g. edit record properties.\r\nThe user needs write permission, and if the table is version controlled, the record must be unreleased." + }, + "canRelease": { + "type": "boolean", + "description": "True if the current user can release this record version." + }, + "canGetModifiableVersion": { + "type": "boolean", + "description": "True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists)." + }, + "canWithdraw": { + "type": "boolean", + "description": "True if the current user can withdraw this record version." + }, + "canDelete": { + "type": "boolean", + "description": "True if the current user can delete this record version." + } + }, + "additionalProperties": false }, "GsaRecordColor": { "enum": [ @@ -110824,7 +81391,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordColor'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordColor'", "x-discriminator-value": "recordColor", "x-discriminator-name": "propertyName" }, @@ -110850,7 +81417,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'record'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'record'", "x-discriminator-value": "record", "x-discriminator-name": "type" }, @@ -110871,7 +81438,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordGuid'", "x-discriminator-value": "recordGuid", "x-discriminator-name": "propertyName" }, @@ -110921,7 +81488,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -110950,7 +81517,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordHistoryGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordHistoryGuid'", "x-discriminator-value": "recordHistoryGuid", "x-discriminator-name": "propertyName" }, @@ -110962,7 +81529,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -110991,100 +81558,10 @@ } ], "additionalProperties": false, - "description": "The unique way to identify a record history (which may have multiple versions) in an MI system\r\n\r\nThis extends: [GsaRecordReference](#model-GsaRecordReference)\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'history'", + "description": "The unique way to identify a record history (which may have multiple versions) in an MI system\r\n\r\nThis extends: GsaRecordReference\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'history'", "x-discriminator-value": "history", "x-discriminator-name": "recordReferenceType" }, - "GsaRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "includeIndirectLinks" - ], - "type": "object", - "properties": { - "includeIndirectLinks": { - "type": "boolean" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordLink'", - "x-discriminator-value": "recordLink", - "x-discriminator-name": "type" - }, - "GsaRecordLinkBase": { - "required": [ - "guid", - "recordLinkGroupType", - "sourceRecordHistoryGuid", - "targetRecordHistoryGuid" - ], - "type": "object", - "properties": { - "recordLinkGroupType": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "sourceRecordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "targetRecordHistoryGuid": { - "type": "string", - "format": "uuid" - }, - "notes": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "A record Link\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLink](#model-GsaStaticRecordLink)\r\n * [GsaCrossDatabaseRecordLink](#model-GsaCrossDatabaseRecordLink)", - "discriminator": { - "propertyName": "recordLinkGroupType", - "mapping": { - "static": "#/components/schemas/GsaStaticRecordLink", - "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLink" - } - } - }, - "GsaRecordLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" - }, - { - "required": [ - "linkGroupGuid" - ], - "type": "object", - "properties": { - "forwards": { - "type": "boolean", - "nullable": true - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'recordLink'", - "x-discriminator-value": "recordLink", - "x-discriminator-name": "itemType" - }, "GsaRecordLinkGroup": { "required": [ "displayNames", @@ -111123,8 +81600,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -111135,184 +81611,37 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLinkGroup](#model-GsaStaticRecordLinkGroup)\r\n * [GsaSmartRecordLinkGroup](#model-GsaSmartRecordLinkGroup)\r\n * [GsaCrossDatabaseRecordLinkGroup](#model-GsaCrossDatabaseRecordLinkGroup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaStaticRecordLinkGroup\r\n * GsaDynamicRecordLinkGroup\r\n * GsaCrossDatabaseRecordLinkGroup", "discriminator": { "propertyName": "type", "mapping": { "static": "#/components/schemas/GsaStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaSmartRecordLinkGroup", + "dynamic": "#/components/schemas/GsaDynamicRecordLinkGroup", "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkGroup" } } }, - "GsaRecordLinkGroupCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaRecordLinkGroupErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaForbidOrphansRecordLinkGroupErrorDetail](#model-GsaForbidOrphansRecordLinkGroupErrorDetail)\r\n * [GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail](#model-GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail)\r\n * [GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail](#model-GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail)\r\n * [GsaNamedEntityRecordLinkGroupErrorDetail](#model-GsaNamedEntityRecordLinkGroupErrorDetail)\r\n * [GsaNameSameAsReverseNameRecordLinkGroupErrorDetail](#model-GsaNameSameAsReverseNameRecordLinkGroupErrorDetail)\r\n * [GsaNoSuchTargetTableRecordLinkGroupErrorDetail](#model-GsaNoSuchTargetTableRecordLinkGroupErrorDetail)\r\n * [GsaReferentialIntegrityModelRecordLinkGroupErrorDetail](#model-GsaReferentialIntegrityModelRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail](#model-GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail](#model-GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail)\r\n * [GsaReverseNameNotProvidedRecordLinkGroupErrorDetail](#model-GsaReverseNameNotProvidedRecordLinkGroupErrorDetail)\r\n * [GsaSmartAttributesRecordLinkGroupErrorDetail](#model-GsaSmartAttributesRecordLinkGroupErrorDetail)\r\n * [GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail](#model-GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "forbidOrphans": "#/components/schemas/GsaForbidOrphansRecordLinkGroupErrorDetail", - "manyToManyForbidOrphans": "#/components/schemas/GsaManyToManyForbidOrphansRecordLinkGroupErrorDetail", - "nameAlreadyExistsAsReverse": "#/components/schemas/GsaNameAlreadyExistsAsReverseRecordLinkGroupErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityRecordLinkGroupErrorDetail", - "nameSameAsReverseName": "#/components/schemas/GsaNameSameAsReverseNameRecordLinkGroupErrorDetail", - "noSuchTargetTable": "#/components/schemas/GsaNoSuchTargetTableRecordLinkGroupErrorDetail", - "referentialIntegrityModel": "#/components/schemas/GsaReferentialIntegrityModelRecordLinkGroupErrorDetail", - "reverseNameAlreadyExists": "#/components/schemas/GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail", - "reverseNameAlreadyExistsAsName": "#/components/schemas/GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail", - "reverseNameNotProvided": "#/components/schemas/GsaReverseNameNotProvidedRecordLinkGroupErrorDetail", - "smartAttributes": "#/components/schemas/GsaSmartAttributesRecordLinkGroupErrorDetail", - "swapNameAndReverseNameCircular": "#/components/schemas/GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail" - } - } - }, - "GsaRecordLinkGroupErrorReason": { - "enum": [ - "forbidOrphans", - "manyToManyForbidOrphans", - "nameAlreadyExistsAsReverse", - "namedEntity", - "nameSameAsReverseName", - "noSuchTargetTable", - "referentialIntegrityModel", - "reverseNameAlreadyExists", - "reverseNameAlreadyExistsAsName", - "reverseNameNotProvided", - "smartAttributes", - "swapNameAndReverseNameCircular" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • forbidOrphans: To set forbid orphans, all records in the target table must be linked to a record in the source table.
    • \r\n
  • manyToManyForbidOrphans: The Many to Many model cannot forbid orphans.
    • \r\n
  • nameAlreadyExistsAsReverse: The name matches the reverse name of a record link group targeting this table.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • nameSameAsReverseName: Record link group name and reverse name cannot be the same.
    • \r\n
  • noSuchTargetTable: Target table not found.
    • \r\n
  • referentialIntegrityModel: The ReferentialIntegrityModel cannot be set due to existing links.
    • \r\n
  • reverseNameAlreadyExists: Record link group with reverse name already exists targeting this target table.
    • \r\n
  • reverseNameAlreadyExistsAsName: The reverse name matches the name of a record link group from the target table.
    • \r\n
  • reverseNameNotProvided: Record link group must have a reverse name.
    • \r\n
  • smartAttributes: The attributes used as linking attribute pairs for a smart link group are not valid.
    • \r\n
  • swapNameAndReverseNameCircular: Cannot swap name and reverse name when the source and target table are the same.
    • \r\n
\r\n" - }, "GsaRecordLinkGroupType": { "enum": [ "static", - "smart", + "dynamic", "crossDatabase" ], "type": "string" }, - "GsaRecordLinkGroupUpdateException": { - "required": [ - "recordLinkGroupGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "recordLinkGroupGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaRecordLinkGroupsInfo": { "type": "object", "properties": { "recordLinkGroups": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "$ref": "#/components/schemas/GsaSlimRecordLinkGroup" }, "nullable": true } }, "additionalProperties": false }, - "GsaRecordLinkResult": { - "required": [ - "linkedRecord", - "recordLinkGroupType" - ], - "type": "object", - "properties": { - "recordLinkGroupType": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "linkedRecord": { - "$ref": "#/components/schemas/GsaSlimRecordVersion" - } - }, - "additionalProperties": false, - "description": "A record link result\r\n\r\nThis is one of: \r\n * [GsaStaticRecordLinkResult](#model-GsaStaticRecordLinkResult)\r\n * [GsaSmartRecordLinkResult](#model-GsaSmartRecordLinkResult)\r\n * [GsaCrossDatabaseRecordLinkResult](#model-GsaCrossDatabaseRecordLinkResult)", - "discriminator": { - "propertyName": "recordLinkGroupType", - "mapping": { - "static": "#/components/schemas/GsaStaticRecordLinkResult", - "smart": "#/components/schemas/GsaSmartRecordLinkResult", - "crossDatabase": "#/components/schemas/GsaCrossDatabaseRecordLinkResult" - } - } - }, - "GsaRecordLinkResults": { - "required": [ - "recordLinkGroup", - "results" - ], - "type": "object", - "properties": { - "recordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimRecordLinkGroup" - }, - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordLinkResult" - } - } - }, - "additionalProperties": false - }, "GsaRecordListHeader": { "required": [ "awaitingApproval", @@ -111447,7 +81776,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordListMember'", + "description": "Criterion that returns records contained within at least one of the referenced record lists.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordListMember'", "x-discriminator-value": "recordListMember", "x-discriminator-name": "type" }, @@ -111560,7 +81889,7 @@ } ], "additionalProperties": false, - "description": "recordList: Search criterion for a set of record lists.\r\n \r\nThe properties in the this class represent an AND search - only lists that match all of the non-null properties will be returned\r\n\r\nThis extends: [GsaListCriterion](#model-GsaListCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordList'", + "description": "recordList: Search criterion for a set of record lists.\r\n \r\nThe properties in the this class represent an AND search - only lists that match all of the non-null properties will be returned\r\n\r\nThis extends: GsaListCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordList'", "x-discriminator-value": "recordList", "x-discriminator-name": "type" }, @@ -111647,8 +81976,7 @@ "releasedDate", "fullName", "shortName", - "recordColor", - "breadcrumbs" + "recordColor" ], "type": "string", "description": "A record property represents data on a record that typically cannot be independently edited,\r\nas opposed to attribute data which may be edited on a record freely (albeit possibly requiring\r\nreleasing a new version). Record properties are usually tracked by the system automatically\r\nand are usually read-only.\r\nNote: for legacy reasons, some 'record properties' do not fall into these criteria, and do\r\nrepresent editable record fields more similar to attribute data. These record properties are\r\nusually exposed in this API as both 'record properties' and 'pseudo-attributes'." @@ -111675,7 +82003,7 @@ } ], "additionalProperties": false, - "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", + "description": "Criterion for a search matching values in a given record property.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", "x-discriminator-value": "recordProperty", "x-discriminator-name": "type" }, @@ -111707,7 +82035,7 @@ } ], "additionalProperties": false, - "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", + "description": "Specifies a record property based sort criterion for a search query.\r\n\r\nsortType: For a text-type sort, whether the results should use a natural or a pure alphabetical sort. Defaults to natural.\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'recordProperty'", "x-discriminator-value": "recordProperty", "x-discriminator-name": "type" }, @@ -111726,7 +82054,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaRecordHistoryReference](#model-GsaRecordHistoryReference)\r\n * [GsaRecordVersionReference](#model-GsaRecordVersionReference)", + "description": "\r\n\r\nThis is one of: \r\n * GsaRecordHistoryReference\r\n * GsaRecordVersionReference", "discriminator": { "propertyName": "recordReferenceType", "mapping": { @@ -111750,37 +82078,21 @@ "databaseKey": { "type": "string" }, - "recordGuid": { + "recordHistoryGuid": { "type": "string", "format": "uuid", "nullable": true }, - "recordHistoryGuid": { + "recordGuid": { "type": "string", "format": "uuid", "nullable": true - }, - "anyRecordHistoryGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "anyRecordGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true } } } ], "additionalProperties": false, - "description": "Criterion that returns records matching a specific reference. The database key must be provided, plus at least one guid\r\nThis can be a single record version GUID or record history GUID, or an array of either which will match on any of the GUIDS\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'reference'", + "description": "Criterion that returns records matching a specific reference. The database key must be provided, along with the record GUID.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'reference'", "x-discriminator-value": "reference", "x-discriminator-name": "type" }, @@ -111814,7 +82126,7 @@ } ], "additionalProperties": false, - "description": "Criterion that returns records matching a specific subset. The database key must be provided, along with either the subset GUID or the subset identity.\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'subset'", + "description": "Criterion that returns records matching a specific subset. The database key must be provided, along with either the subset GUID or the subset identity.\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'subset'", "x-discriminator-value": "subset", "x-discriminator-name": "type" }, @@ -111827,19 +82139,6 @@ "type": "string", "description": "An API-level enum for the supported record types." }, - "GsaRecordTypeCriterion": { - "type": "object", - "properties": { - "recordTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordType" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaRecordTypeProperty": { "type": "object", "allOf": [ @@ -111856,50 +82155,13 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordType'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'recordType'", "x-discriminator-value": "recordType", "x-discriminator-name": "propertyName" }, - "GsaRecordUserCapabilities": { - "required": [ - "canDelete", - "canGetModifiableVersion", - "canModify", - "canRelease", - "canWithdraw", - "canWrite" - ], - "type": "object", - "properties": { - "canWrite": { - "type": "boolean", - "description": "True if the current user has write permission for this record version, and is in write mode.\r\nWrite permission is required to edit record properties, and to perform version control actions." - }, - "canModify": { - "type": "boolean", - "description": "True if the current user can modify this record version, e.g. edit record properties.\r\nThe user needs write permission, and if the table is version controlled, the record must be unreleased." - }, - "canRelease": { - "type": "boolean", - "description": "True if the current user can release this record version." - }, - "canGetModifiableVersion": { - "type": "boolean", - "description": "True if the current user can get a modifiable version of this record version (gets the latest modifiable record version, or creates a new one if none exists)." - }, - "canWithdraw": { - "type": "boolean", - "description": "True if the current user can withdraw this record version." - }, - "canDelete": { - "type": "boolean", - "description": "True if the current user can delete this record version." - } - }, - "additionalProperties": false - }, "GsaRecordVersion": { "required": [ + "capabilities", "createdByUser", "createdDate", "databaseKey", @@ -111912,7 +82174,6 @@ "recordType", "shortName", "table", - "userCapabilities", "versionNumber", "versionState" ], @@ -111955,8 +82216,8 @@ "recordColor": { "$ref": "#/components/schemas/GsaRecordColor" }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaRecordUserCapabilities" + "capabilities": { + "$ref": "#/components/schemas/GsaRecordCapabilities" }, "versionNumber": { "type": "integer", @@ -111995,7 +82256,7 @@ } ], "additionalProperties": false, - "description": "The unique way to identify a record version in an MI system\r\n\r\nThis extends: [GsaRecordReference](#model-GsaRecordReference)\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'version'", + "description": "The unique way to identify a record version in an MI system\r\n\r\nThis extends: GsaRecordReference\r\n\r\nThe value of discriminator property ('recordReferenceType') must be equal to 'version'", "x-discriminator-value": "version", "x-discriminator-name": "recordReferenceType" }, @@ -112038,21 +82299,14 @@ "enum": [ "expression", "versionControlledData", - "smartLinkGroup", + "dynamicLinkGroup", "tabularAttribute", "xyChartTemplate", "searchMask", "securityAttribute", "attribute", "data", - "defaultParameterValue", - "functionalDataDefault", - "multiValuedPointData", - "tabularColumn", - "databaseCurrencyUnit", - "unit", - "parameter", - "constant" + "defaultParameterValue" ], "type": "string" }, @@ -112064,37 +82318,6 @@ ], "type": "string" }, - "GsaReferentialIntegrityModelRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "The ReferentialIntegrityModel cannot be set due to existing links.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'referentialIntegrityModel'", - "x-discriminator-value": "referentialIntegrityModel", - "x-discriminator-name": "reason" - }, - "GsaRegisterUpdateRequest": { - "required": [ - "applyOptions", - "header" - ], - "type": "object", - "properties": { - "header": { - "$ref": "#/components/schemas/GsaDataUpdateHeader" - }, - "applyOptions": { - "$ref": "#/components/schemas/GsaApplyOptions" - } - }, - "additionalProperties": false - }, "GsaReleaseRecordVersionControlException": { "type": "object", "properties": { @@ -112103,7 +82326,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -112123,7 +82346,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -112153,7 +82376,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'releasedDate'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'releasedDate'", "x-discriminator-value": "releasedDate", "x-discriminator-name": "propertyName" }, @@ -112168,7 +82391,7 @@ } ], "additionalProperties": false, - "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: [GsaSortCriterion](#model-GsaSortCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'relevance'", + "description": "Specifies a relevance based sort criterion for a search query\r\n\r\nThis extends: GsaSortCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'relevance'", "x-discriminator-value": "relevance", "x-discriminator-name": "type" }, @@ -112193,64 +82416,12 @@ "properties": { "layoutSections": { "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - }, - "additionalProperties": false - }, - "GsaReplacePermissionCategoriesRequest": { - "required": [ - "categories" - ], - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - "description": "This can result in adding, modifying and deleting permission categories.\r\nTo insert a new category, use a [GsaCreatePutPermissionCategory](#model-GsaCreatePutPermissionCategory).\r\nTo modify an existing category, use a [GsaUpdatePutPermissionCategory](#model-GsaUpdatePutPermissionCategory).\r\nExisting categories will be matched by GUID.\r\nIf an existing category is not included, it will be deleted." - } - }, - "additionalProperties": false - }, - "GsaReplacePermissionCategoryErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail](#model-GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail)\r\n * [GsaCategoryReplacePermissionCategoryErrorDetail](#model-GsaCategoryReplacePermissionCategoryErrorDetail)\r\n * [GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail](#model-GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail)\r\n * [GsaTooManyPermissionsReplacePermissionCategoryErrorDetail](#model-GsaTooManyPermissionsReplacePermissionCategoryErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "duplicateCategories": "#/components/schemas/GsaDuplicateCategoriesReplacePermissionCategoryErrorDetail", - "category": "#/components/schemas/GsaCategoryReplacePermissionCategoryErrorDetail", - "noSuchCategories": "#/components/schemas/GsaNoSuchCategoriesReplacePermissionCategoryErrorDetail", - "tooManyPermissions": "#/components/schemas/GsaTooManyPermissionsReplacePermissionCategoryErrorDetail" - } - } - }, - "GsaReplacePermissionCategoryErrorReason": { - "enum": [ - "duplicateCategories", - "category", - "noSuchCategories", - "tooManyPermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • duplicateCategories: Duplicate categories were specified, either by name or GUID.
    • \r\n
  • category: The category is not valid.
    • \r\n
  • noSuchCategories: One or more permission categories specified for update could not be found.
    • \r\n
  • tooManyPermissions: The new permissions cannot be added, there are not enough permissions available. A schema for a database may have up to 128 permissions. This is the total number of permissions that have ever existed in the schema
    • \r\n
\r\n" + "items": { + "$ref": "#/components/schemas/GsaSlimEntity" + } + } + }, + "additionalProperties": false }, "GsaReplacementString": { "required": [ @@ -112289,93 +82460,95 @@ }, "additionalProperties": false }, - "GsaResolveLinkTargetsInfo": { + "GsaResolvedLink": { "required": [ - "resolvedLinkTargets" + "displayNames", + "guid", + "linkInfo", + "name", + "reverseName", + "type" ], "type": "object", "properties": { - "resolvedLinkTargets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaResolvedLinkTarget" + "identity": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/GsaLinkAttributeType" + }, + "reverseName": { + "type": "string" + }, + "reverseDisplayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + }, + "nullable": true + }, + "linkInfo": { + "$ref": "#/components/schemas/GsaResolvedLinkInfo" + }, + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true } + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaResolveLinkTargetsRequest": { + "GsaResolvedLinkInfo": { "required": [ - "linkTargets" + "linkSource", + "linkTarget" ], "type": "object", "properties": { - "linkTargets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaLinkTarget" - } + "linkSource": { + "$ref": "#/components/schemas/GsaResolvedLinkTarget" + }, + "linkTarget": { + "$ref": "#/components/schemas/GsaResolvedLinkTarget" } }, "additionalProperties": false }, "GsaResolvedLinkTarget": { "required": [ - "linkTarget", - "tables" + "databaseGuid", + "databaseVersionGuid", + "tableGuid" ], "type": "object", "properties": { - "linkTarget": { - "$ref": "#/components/schemas/GsaLinkTarget" + "databaseGuid": { + "type": "string", + "format": "uuid" }, - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimTable" - } + "databaseVersionGuid": { + "type": "string", + "format": "uuid" + }, + "tableGuid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false }, - "GsaResolvedTargetAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTargetAttribute" - }, - { - "required": [ - "attributeType", - "displayNames", - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - } - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "aboutAttribute": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTargetAttribute](#model-GsaTargetAttribute)\r\n\r\nThe value of discriminator property ('targetType') must be equal to 'resolved'", - "x-discriminator-value": "resolved", - "x-discriminator-name": "targetType" - }, "GsaResponseOptions": { "type": "object", "properties": { @@ -112410,167 +82583,6 @@ }, "additionalProperties": false }, - "GsaRetargetPotentialRequest": { - "required": [ - "targetDatabaseKeys" - ], - "type": "object", - "properties": { - "targetDatabaseKeys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of database keys to check for retargeting potential." - } - }, - "additionalProperties": false, - "description": "Request to get databases with retarget potential - whether there are any cross-database tabular attributes that target them." - }, - "GsaRetargetRequest": { - "required": [ - "newTargetDatabaseKey", - "previousTargetDatabaseKey" - ], - "type": "object", - "properties": { - "previousTargetDatabaseKey": { - "type": "string", - "description": "Database key that the tabular attributes were targeting before the operation." - }, - "newTargetDatabaseKey": { - "type": "string", - "description": "Database key that the tabular attributes will target after the operation." - } - }, - "additionalProperties": false, - "description": "Request to retarget tabular attributes from one database to another." - }, - "GsaRetargetResult": { - "required": [ - "attributeName", - "result", - "sourceDatabaseKey", - "tableName" - ], - "type": "object", - "properties": { - "sourceDatabaseKey": { - "type": "string", - "description": "Database key of the source database - the one holding the tabular attribute that was retargeted." - }, - "tableName": { - "type": "string", - "description": "Table name of the source table - the one holding the tabular attribute that was retargeted." - }, - "attributeName": { - "type": "string", - "description": "Name of the tabular attribute that was retargeted." - }, - "result": { - "$ref": "#/components/schemas/GsaRetargetResultType" - } - }, - "additionalProperties": false, - "description": "Result of a retargeting operation.\r\n\r\nresult: Result type of the retargeting operation." - }, - "GsaRetargetResultType": { - "enum": [ - "success", - "tableNotFound", - "linkingAttributeNotFound", - "columnMissing", - "missingAdminPermissions" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • success: Success.
    • \r\n
  • tableNotFound: Target table could not be found.
    • \r\n
  • linkingAttributeNotFound: Linking attribute could not be found.
    • \r\n
  • columnMissing: Column missing.
    • \r\n
  • missingAdminPermissions: User does not have admin permissions to the database.
    • \r\n
\r\n" - }, - "GsaRetargetResultsInfo": { - "required": [ - "results" - ], - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRetargetResult" - } - } - }, - "additionalProperties": false - }, - "GsaReverseNameAlreadyExistsAsNameRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "reverseName", - "targetTableGuid" - ], - "type": "object", - "properties": { - "reverseName": { - "type": "string" - }, - "targetTableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "The reverse name matches the name of a record link group from the target table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameAlreadyExistsAsName'", - "x-discriminator-value": "reverseNameAlreadyExistsAsName", - "x-discriminator-name": "reason" - }, - "GsaReverseNameAlreadyExistsRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "reverseName", - "targetTableGuid" - ], - "type": "object", - "properties": { - "reverseName": { - "type": "string" - }, - "targetTableGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Record link group with reverse name already exists targeting this target table.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameAlreadyExists'", - "x-discriminator-value": "reverseNameAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaReverseNameNotProvidedRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Record link group must have a reverse name.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'reverseNameNotProvided'", - "x-discriminator-value": "reverseNameNotProvided", - "x-discriminator-name": "reason" - }, "GsaRichTextType": { "enum": [ "plain", @@ -112595,21 +82607,6 @@ }, "additionalProperties": false }, - "GsaRoleNotProvidedPermissionErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Role must be provided, and cannot be empty or whitespace.\r\n\r\nThis extends: [GsaPermissionErrorDetail](#model-GsaPermissionErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'roleNotProvided'", - "x-discriminator-value": "roleNotProvided", - "x-discriminator-name": "reason" - }, "GsaRollupExportFailure": { "type": "object", "allOf": [ @@ -112629,7 +82626,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaExportFailure](#model-GsaExportFailure)\r\n\r\nThe value of discriminator property ('type') must be equal to 'rollup'", + "description": "\r\n\r\nThis extends: GsaExportFailure\r\n\r\nThe value of discriminator property ('type') must be equal to 'rollup'", "x-discriminator-value": "rollup", "x-discriminator-name": "type" }, @@ -112677,104 +82674,19 @@ }, "additionalProperties": false }, - "GsaRootFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "You cannot move the root folder.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'root'", - "x-discriminator-value": "root", - "x-discriminator-name": "reason" - }, - "GsaRootRecordNotAvailableToRenameErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "required": [ - "tableName" - ], - "type": "object", - "properties": { - "tableName": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'rootRecordNotAvailableToRename'", - "x-discriminator-value": "rootRecordNotAvailableToRename", - "x-discriminator-name": "reason" - }, - "GsaRuleEngine": { - "required": [ - "fullyQualifiedTypeName", - "name" - ], + "GsaSaveSearchRequest": { "type": "object", "properties": { - "name": { + "searchConfig": { "type": "string", - "description": "The name of the rule engine." + "nullable": true }, - "fullyQualifiedTypeName": { - "type": "string", - "description": "The fully qualified name of the rule engine implementation." + "detail": { + "$ref": "#/components/schemas/GsaSearchDetail" } }, "additionalProperties": false }, - "GsaSameParentFileMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFileMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Unable to move file as it is already under this folder.\r\n\r\nThis extends: [GsaFileMoveErrorDetail](#model-GsaFileMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sameParent'", - "x-discriminator-value": "sameParent", - "x-discriminator-name": "reason" - }, - "GsaSameParentFolderMoveErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderMoveErrorDetail" - }, - { - "type": "object", - "properties": { - "newParentFolderGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "Unable to move folder as it is already under this folder.\r\n\r\nThis extends: [GsaFolderMoveErrorDetail](#model-GsaFolderMoveErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sameParent'", - "x-discriminator-value": "sameParent", - "x-discriminator-name": "reason" - }, "GsaSchemaTooNewAddDatabaseValidationIssue": { "type": "object", "allOf": [ @@ -112794,7 +82706,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooNew'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooNew'", "x-discriminator-value": "schemaTooNew", "x-discriminator-name": "IssueType" }, @@ -112817,7 +82729,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooOld'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'schemaTooOld'", "x-discriminator-value": "schemaTooOld", "x-discriminator-name": "IssueType" }, @@ -112850,6 +82762,28 @@ }, "additionalProperties": false }, + "GsaSearchDetail": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "notes": { + "type": "string", + "nullable": true + }, + "criteria": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "GsaSearchIndexStatus": { "type": "object", "properties": { @@ -112893,54 +82827,6 @@ }, "additionalProperties": false }, - "GsaSearchMask": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttribute" - }, - "nullable": true - }, - "recordProperties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaRecordProperty" - }, - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSearchMaskInfo": { - "type": "object", - "properties": { - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimSearchMask" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaSearchMaskUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -112961,7 +82847,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'searchMask'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'searchMask'", "x-discriminator-value": "searchMask", "x-discriminator-name": "referencedByType" }, @@ -112981,19 +82867,10 @@ }, "pagingOptions": { "$ref": "#/components/schemas/GsaPagingOptions" - }, - "tableSearchBehaviour": { - "$ref": "#/components/schemas/GsaTableSearchBehaviour" - }, - "findSimilarId": { - "type": "string", - "description": "An optional identifier of a find similar calculation to include in this search. Results will include a similarity score.", - "format": "uuid", - "nullable": true } }, "additionalProperties": false, - "description": "\r\n\r\ncriterion: The main search criterion.\r\n\r\npagingOptions: An optional field for paging options. If provided, the response will contain an identifier that can be used to retrieve the other pages.\r\n\r\ntableSearchBehaviour: Determines the behaviour of records in tables that are marked as hidden from search. The default behaviour is that these records are excluded." + "description": "\r\n\r\ncriterion: The main search criterion.\r\n\r\npagingOptions: An optional field for paging options. If provided, the response will contain an identifier that can be used to retrieve the other pages." }, "GsaSearchResponse": { "required": [ @@ -113082,12 +82959,6 @@ "format": "double", "nullable": true }, - "similarityScore": { - "type": "number", - "format": "double", - "nullable": true, - "readOnly": true - }, "sortingValue": { "$ref": "#/components/schemas/GsaSortingValue" } @@ -113105,172 +82976,6 @@ }, "additionalProperties": false }, - "GsaSearchServiceStatus": { - "required": [ - "isRunning" - ], - "type": "object", - "properties": { - "isRunning": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaSearchTemplate": { - "required": [ - "guid", - "name", - "table" - ], - "type": "object", - "properties": { - "searchAttributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSearchTemplateAttributeItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'attribute'", - "x-discriminator-value": "attribute", - "x-discriminator-name": "itemType" - }, - "GsaSearchTemplateInfo": { - "type": "object", - "properties": { - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimSearchTemplate" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaSearchTemplateItem": { - "required": [ - "attribute", - "itemType" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaSearchTemplateItemType" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSearchTemplateAttributeItem](#model-GsaSearchTemplateAttributeItem)\r\n * [GsaSearchTemplateTabularColumnItem](#model-GsaSearchTemplateTabularColumnItem)\r\n * [GsaSearchTemplateLinkItem](#model-GsaSearchTemplateLinkItem)", - "discriminator": { - "propertyName": "itemType", - "mapping": { - "attribute": "#/components/schemas/GsaSearchTemplateAttributeItem", - "tabularColumn": "#/components/schemas/GsaSearchTemplateTabularColumnItem", - "link": "#/components/schemas/GsaSearchTemplateLinkItem" - } - } - }, - "GsaSearchTemplateItemType": { - "enum": [ - "attribute", - "tabularColumn", - "link" - ], - "type": "string" - }, - "GsaSearchTemplateLinkItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "required": [ - "forwards", - "linkType", - "recordLinkGroup" - ], - "type": "object", - "properties": { - "recordLinkGroup": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "linkType": { - "$ref": "#/components/schemas/GsaRecordLinkGroupType" - }, - "targetDatabase": { - "type": "string", - "description": "May be null for a static link group, or a cross database link group that can target multiple databases", - "format": "uuid", - "nullable": true - }, - "forwards": { - "type": "boolean", - "description": "true if the link points from the table the template is in; or false if it points towards the table the template is in (an inbound link)." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'link'", - "x-discriminator-value": "link", - "x-discriminator-name": "itemType" - }, - "GsaSearchTemplateTabularColumnItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSearchTemplateItem" - }, - { - "required": [ - "tabularColumn" - ], - "type": "object", - "properties": { - "tabularColumn": { - "$ref": "#/components/schemas/GsaTabularColumn" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSearchTemplateItem](#model-GsaSearchTemplateItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'tabularColumn'", - "x-discriminator-value": "tabularColumn", - "x-discriminator-name": "itemType" - }, "GsaSearchableRecordProperty": { "enum": [ "createdDate", @@ -113291,6 +82996,27 @@ "type": "string", "description": "Properties of a record that can be used to in searches

Possible values:

\r\n
    \r\n
  • createdDate: The date a record was created.
    • \r\n
  • creator: The username of the person who created the record.
    • \r\n
  • lastModifiedDate: The date a record was last modified.
    • \r\n
  • lastModifier: The username of the person who last modified the record.
    • \r\n
  • recordType: Whether we return records, generics or folders (or a mixture).
    • \r\n
  • color: The color of the record.
    • \r\n
  • versionState: The version state of the records that will be returned. Only Released, Unreleased or Unversioned are supported.
    • \r\n
  • versionNumber: The version number of the record.
    • \r\n
  • recordName: The full name of the record.
    • \r\n
  • treeName: The name of the record as it is displayed in the tree.
    • \r\n
  • databaseKey: The database key of the record.
    • \r\n
  • tableName: The name of the table that the record is in.
    • \r\n
  • tableIdentity: The identity of the table that the record is in.
    • \r\n
  • tableGuid: The guid of the table that the record is in.
    • \r\n
\r\n" }, + "GsaSecurityAttributeGrouping": { + "type": "object", + "properties": { + "identity": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + }, + "availableDiscreteValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaDiscreteValue" + }, + "nullable": true + } + }, + "additionalProperties": false + }, "GsaSecurityAttributeUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -113311,7 +83037,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'securityAttribute'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'securityAttribute'", "x-discriminator-value": "securityAttribute", "x-discriminator-name": "referencedByType" }, @@ -113332,152 +83058,57 @@ "additionalProperties": false, "description": "The security groups that apply to an integration schema. If null or empty, the default MI security groups will be used." }, - "GsaSelection": { + "GsaSelectionSearch": { "type": "object", "properties": { - "tableGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "attributeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "recordGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "discreteTypeGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "parameterGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "layoutGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "subsetGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true - }, - "standardNameGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "searchIdentifier": { + "type": "string", + "format": "uuid" }, - "recordLinkedGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "name": { + "type": "string", "nullable": true }, - "unitGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "description": { + "type": "string", "nullable": true }, - "replacementStringGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "notes": { + "type": "string", "nullable": true }, - "constantGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" + "currentUserAccessInfo": { + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "boolean" + }, + "nullable": true }, "nullable": true }, - "unitSystemGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "criteria": { + "type": "string", "nullable": true }, - "fileGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, + "exploreConfig": { + "type": "string", "nullable": true }, - "searchMaskGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "createdTimestamp": { + "type": "string", + "format": "date-time" }, - "searchTemplateGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "createdUserOrGroup": { + "$ref": "#/components/schemas/GsaUserOrGroup" }, - "dynamicLinkGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "lastModifiedTimestamp": { + "type": "string", + "format": "date-time" }, - "crossDatabaseLinkGroupGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "nullable": true + "lastModifiedUserOrGroup": { + "$ref": "#/components/schemas/GsaUserOrGroup" } }, "additionalProperties": false @@ -113524,7 +83155,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaGraph](#model-GsaGraph)\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'\r\n\r\nThis is one of: \r\n * [GsaFloatSeriesGraph](#model-GsaFloatSeriesGraph)\r\n * [GsaDiscreteSeriesGraph](#model-GsaDiscreteSeriesGraph)", + "description": "\r\n\r\nThis extends: GsaGraph\r\n\r\nThe value of discriminator property ('graphType') must be equal to 'series'\r\n\r\nThis is one of: \r\n * GsaFloatSeriesGraph\r\n * GsaDiscreteSeriesGraph", "x-discriminator-value": "series", "x-discriminator-name": "graphType" }, @@ -113548,7 +83179,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'datetime'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'datetime'", "x-discriminator-value": "datetime", "x-discriminator-name": "setDatumType" }, @@ -113563,7 +83194,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSetIntegerDatum](#model-GsaSetIntegerDatum)\r\n * [GsaSetLogicalDatum](#model-GsaSetLogicalDatum)\r\n * [GsaSetShortTextDatum](#model-GsaSetShortTextDatum)\r\n * [GsaSetRangeDatum](#model-GsaSetRangeDatum)\r\n * [GsaSetDateTimeDatum](#model-GsaSetDateTimeDatum)\r\n * [GsaSetLongTextDatum](#model-GsaSetLongTextDatum)\r\n * [GsaSetHyperlinkDatum](#model-GsaSetHyperlinkDatum)\r\n * [GsaSetPointDatum](#model-GsaSetPointDatum)\r\n * [GsaSetDiscreteDatum](#model-GsaSetDiscreteDatum)\r\n * [GsaSetTabularDatum](#model-GsaSetTabularDatum)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSetIntegerDatum\r\n * GsaSetLogicalDatum\r\n * GsaSetShortTextDatum\r\n * GsaSetRangeDatum\r\n * GsaSetDateTimeDatum\r\n * GsaSetLongTextDatum\r\n * GsaSetHyperlinkDatum\r\n * GsaSetPointDatum\r\n * GsaSetDiscreteDatum\r\n * GsaSetTabularDatum", "discriminator": { "propertyName": "setDatumType", "mapping": { @@ -113618,7 +83249,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "setDatumType" }, @@ -113641,7 +83272,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetParameterValue](#model-GsaSetParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaSetParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "parameterType" }, @@ -113672,7 +83303,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'hyperLink'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'hyperLink'", "x-discriminator-value": "hyperLink", "x-discriminator-name": "setDatumType" }, @@ -113696,7 +83327,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "setDatumType" }, @@ -113719,7 +83350,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "setDatumType" }, @@ -113742,7 +83373,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "setDatumType" }, @@ -113766,7 +83397,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetParameterValue](#model-GsaSetParameterValue)\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaSetParameterValue\r\n\r\nThe value of discriminator property ('parameterType') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "parameterType" }, @@ -113781,7 +83412,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaSetDiscreteParameterValue](#model-GsaSetDiscreteParameterValue)\r\n * [GsaSetNumericParameterValue](#model-GsaSetNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaSetDiscreteParameterValue\r\n * GsaSetNumericParameterValue", "discriminator": { "propertyName": "parameterType", "mapping": { @@ -113832,7 +83463,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "setDatumType" }, @@ -113864,15 +83495,27 @@ }, { "required": [ - "estimated" + "estimated", + "highValue", + "highValueIsInclusive", + "lowValue", + "lowValueIsInclusive" ], "type": "object", "properties": { - "lowEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "lowValue": { + "type": "number", + "format": "double" }, - "highEndpoint": { - "$ref": "#/components/schemas/GsaRangeEndpoint" + "highValue": { + "type": "number", + "format": "double" + }, + "lowValueIsInclusive": { + "type": "boolean" + }, + "highValueIsInclusive": { + "type": "boolean" }, "estimated": { "type": "boolean" @@ -113881,7 +83524,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "setDatumType" }, @@ -113904,7 +83547,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "setDatumType" }, @@ -113930,7 +83573,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSetDatum](#model-GsaSetDatum)\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'tabular'", + "description": "\r\n\r\nThis extends: GsaSetDatum\r\n\r\nThe value of discriminator property ('setDatumType') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "setDatumType" }, @@ -113949,62 +83592,6 @@ }, "additionalProperties": false }, - "GsaSetUnitEquivalent": { - "required": [ - "equivalentUnitGuid", - "unitGuid", - "unitSystemGuid" - ], - "type": "object", - "properties": { - "unitGuid": { - "type": "string", - "format": "uuid" - }, - "unitSystemGuid": { - "type": "string", - "format": "uuid" - }, - "equivalentUnitGuid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSetUnitEquivalentsException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaSetUnitEquivalentsInfo": { - "type": "object", - "properties": { - "setUnitEquivalents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSetUnitEquivalent" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaShortNameProperty": { "type": "object", "allOf": [ @@ -114022,7 +83609,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'shortName'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'shortName'", "x-discriminator-value": "shortName", "x-discriminator-name": "propertyName" }, @@ -114046,7 +83633,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAggregationDatum](#model-GsaAggregationDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaAggregationDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "datumType" }, @@ -114073,7 +83660,7 @@ } ], "additionalProperties": false, - "description": "Criterion for aggregating data within a short-text attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: [GsaAggregationDatumCriterion](#model-GsaAggregationDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "Criterion for aggregating data within a short-text attribute. The returned aggregation will contain the most common\r\nterms for the attribute across records in the aggregation scope, with a count of records for each term.\r\n\r\nThis extends: GsaAggregationDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -114100,7 +83687,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -114123,7 +83710,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "datumType" }, @@ -114149,7 +83736,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -114164,7 +83751,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, @@ -114187,7 +83774,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDatumCriterion](#model-GsaDatumCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortTextPrefix'", + "description": "\r\n\r\nThis extends: GsaDatumCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortTextPrefix'", "x-discriminator-value": "shortTextPrefix", "x-discriminator-name": "type" }, @@ -114212,53 +83799,6 @@ }, "additionalProperties": false }, - "GsaSimilaritySetting": { - "required": [ - "attribute", - "weight", - "weightingType" - ], - "type": "object", - "properties": { - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "weight": { - "type": "number", - "format": "double" - }, - "weightingType": { - "$ref": "#/components/schemas/GsaWeightingType" - } - }, - "additionalProperties": false - }, - "GsaSimilaritySettings": { - "required": [ - "settings" - ], - "type": "object", - "properties": { - "tableGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "useKnockdown": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "settings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSimilaritySetting" - } - } - }, - "additionalProperties": false - }, "GsaSimpleAttributeToExport": { "type": "object", "allOf": [ @@ -114278,7 +83818,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nrollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked data should be rolled up\r\n\r\nsummaryRollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify that the data should be rolled up and included in the summary row\r\n\r\nThis extends: [GsaAttributeToExport](#model-GsaAttributeToExport)\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'simple'", + "description": "\r\n\r\nrollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify how linked data should be rolled up\r\n\r\nsummaryRollUpType: Optional: if this attribute is being used as part of a tabular export, this can be used to specify that the data should be rolled up and included in the summary row\r\n\r\nThis extends: GsaAttributeToExport\r\n\r\nThe value of discriminator property ('attributeType') must be equal to 'simple'", "x-discriminator-value": "simple", "x-discriminator-name": "attributeType" }, @@ -114287,7 +83827,6 @@ "displayNames", "guid", "isHiddenFromSearchCriteria", - "isProtected", "name", "table", "type" @@ -114304,10 +83843,6 @@ "type": "boolean", "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, "table": { "$ref": "#/components/schemas/GsaSlimEntity" }, @@ -114316,8 +83851,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -114329,47 +83863,13 @@ }, "additionalProperties": false }, - "GsaSlimAttributeWithHelpPath": { + "GsaSlimConfiguration": { "required": [ - "displayNames", "guid", - "isHiddenFromSearchCriteria", - "isProtected", - "name", - "table", - "type" + "name" ], "type": "object", "properties": { - "helpPath": { - "type": "string", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "aboutAttribute": { - "$ref": "#/components/schemas/GsaSlimTypedAttribute" - }, - "isHiddenFromSearchCriteria": { - "type": "boolean", - "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches." - }, - "isProtected": { - "type": "boolean", - "description": "If true, the attribute is protected from all changes." - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -114380,7 +83880,7 @@ }, "additionalProperties": false }, - "GsaSlimConfiguration": { + "GsaSlimConstant": { "required": [ "guid", "name" @@ -114395,15 +83895,15 @@ "format": "uuid" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Constant base data (name and guid)\r\nNo extra properties compared to SlimNamedEntity yet, but exists for consistency with other slim entity types" }, "GsaSlimDatabase": { "required": [ "isLocked", "isReadOnly", "key", - "status", - "userCapabilities" + "status" ], "type": "object", "properties": { @@ -114448,16 +83948,7 @@ }, "schemaVersion": { "type": "string", - "nullable": true - }, - "userCapabilities": { - "$ref": "#/components/schemas/GsaDatabaseUserCapabilities" - }, - "configurationDetails": { - "$ref": "#/components/schemas/GsaConfigurationDetails" - }, - "issues": { - "$ref": "#/components/schemas/GsaDatabaseIssues" + "nullable": true } }, "additionalProperties": false @@ -114466,7 +83957,6 @@ "required": [ "guid", "isOrdered", - "isProtected", "name" ], "type": "object", @@ -114474,10 +83964,6 @@ "isOrdered": { "type": "boolean" }, - "isProtected": { - "type": "boolean", - "description": "If true, the discrete type is protected from all changes." - }, "name": { "type": "string" }, @@ -114504,14 +83990,10 @@ "GsaSlimExpression": { "required": [ "guid", - "name", - "table" + "name" ], "type": "object", "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, "name": { "type": "string" }, @@ -114570,8 +84052,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -114594,26 +84075,17 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLayoutSection](#model-GsaLayoutSection)\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'slim'", + "description": "\r\n\r\nThis extends: GsaLayoutSection\r\n\r\nThe value of discriminator property ('sectionDetailType') must be equal to 'slim'", "x-discriminator-value": "slim", "x-discriminator-name": "sectionDetailType" }, - "GsaSlimLocalizedEntity": { + "GsaSlimNamedEntity": { "required": [ - "displayNames", "guid", "name" ], "type": "object", "properties": { - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -114624,16 +84096,24 @@ }, "additionalProperties": false }, - "GsaSlimNamedEntity": { + "GsaSlimNamedUnit": { "required": [ "guid", - "name" + "name", + "symbol" ], "type": "object", "properties": { "name": { "type": "string" }, + "symbol": { + "type": "string" + }, + "relativeSymbol": { + "type": "string", + "nullable": true + }, "guid": { "type": "string", "format": "uuid" @@ -114671,8 +84151,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -114684,30 +84163,30 @@ }, "additionalProperties": false }, - "GsaSlimParameterWithHelpPath": { + "GsaSlimPermission": { "required": [ - "displayNames", "guid", - "name", - "type" + "name" ], "type": "object", "properties": { - "helpPath": { - "type": "string", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/GsaParameterType" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + "name": { + "type": "string" }, + "guid": { + "type": "string", + "format": "uuid" + } + }, + "additionalProperties": false + }, + "GsaSlimPermissionCategory": { + "required": [ + "guid", + "name" + ], + "type": "object", + "properties": { "name": { "type": "string" }, @@ -114829,8 +84308,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -114886,52 +84364,6 @@ "additionalProperties": false, "description": "Replacement String base data (name and guid)\r\nNo extra properties compared to SlimNamedEntity yet, but exists for consistency with other slim entity types" }, - "GsaSlimSearchMask": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSlimSearchTemplate": { - "required": [ - "guid", - "name", - "table" - ], - "type": "object", - "properties": { - "description": { - "type": "string", - "nullable": true - }, - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaSlimSubset": { "required": [ "displayNames", @@ -114945,8 +84377,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -114960,7 +84391,6 @@ }, "GsaSlimTable": { "required": [ - "databaseKey", "displayNames", "guid", "isHiddenFromBrowse", @@ -114971,9 +84401,6 @@ ], "type": "object", "properties": { - "databaseKey": { - "type": "string" - }, "isHiddenFromBrowse": { "type": "boolean" }, @@ -114994,8 +84421,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -115009,7 +84435,6 @@ }, "GsaSlimTypedAttribute": { "required": [ - "displayNames", "guid", "name", "type" @@ -115019,14 +84444,6 @@ "type": { "$ref": "#/components/schemas/GsaAttributeType" }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, "name": { "type": "string" }, @@ -115058,218 +84475,66 @@ }, "additionalProperties": false }, - "GsaSmartAttributesErrorDetail": { + "GsaSlimUnitSystem": { "required": [ - "message", - "reason" + "displayNames", + "guid", + "name" ], "type": "object", "properties": { - "message": { + "displayNames": { + "type": "object", + "additionalProperties": { + "type": "string", + "nullable": true + } + }, + "name": { "type": "string" }, - "reason": { - "$ref": "#/components/schemas/GsaSmartAttributesErrorReason" + "guid": { + "type": "string", + "format": "uuid" } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail](#model-GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail)\r\n * [GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail](#model-GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail)\r\n * [GsaAttributePairTypeMismatchSmartAttributesErrorDetail](#model-GsaAttributePairTypeMismatchSmartAttributesErrorDetail)\r\n * [GsaAttributeTypeNotSupportedSmartAttributesErrorDetail](#model-GsaAttributeTypeNotSupportedSmartAttributesErrorDetail)\r\n * [GsaNoAttributePairsSmartAttributesErrorDetail](#model-GsaNoAttributePairsSmartAttributesErrorDetail)\r\n * [GsaNoSuchAttributeSmartAttributesErrorDetail](#model-GsaNoSuchAttributeSmartAttributesErrorDetail)\r\n * [GsaSourceCannotBeTargetSmartAttributesErrorDetail](#model-GsaSourceCannotBeTargetSmartAttributesErrorDetail)\r\n * [GsaTooManyAttributePairsSmartAttributesErrorDetail](#model-GsaTooManyAttributePairsSmartAttributesErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "attributeAlreadySpecified": "#/components/schemas/GsaAttributeAlreadySpecifiedSmartAttributesErrorDetail", - "attributePairDiscreteTypeMismatch": "#/components/schemas/GsaAttributePairDiscreteTypeMismatchSmartAttributesErrorDetail", - "attributePairTypeMismatch": "#/components/schemas/GsaAttributePairTypeMismatchSmartAttributesErrorDetail", - "attributeTypeNotSupported": "#/components/schemas/GsaAttributeTypeNotSupportedSmartAttributesErrorDetail", - "noAttributePairs": "#/components/schemas/GsaNoAttributePairsSmartAttributesErrorDetail", - "noSuchAttribute": "#/components/schemas/GsaNoSuchAttributeSmartAttributesErrorDetail", - "sourceCannotBeTarget": "#/components/schemas/GsaSourceCannotBeTargetSmartAttributesErrorDetail", - "tooManyAttributePairs": "#/components/schemas/GsaTooManyAttributePairsSmartAttributesErrorDetail" - } - } - }, - "GsaSmartAttributesErrorReason": { - "enum": [ - "attributeAlreadySpecified", - "attributePairDiscreteTypeMismatch", - "attributePairTypeMismatch", - "attributeTypeNotSupported", - "noAttributePairs", - "noSuchAttribute", - "sourceCannotBeTarget", - "tooManyAttributePairs" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • attributeAlreadySpecified: Smart record link group source and target attributes cannot contain duplicates.
    • \r\n
  • attributePairDiscreteTypeMismatch: Discrete attributes in attribute pairs must have the same discrete type.
    • \r\n
  • attributePairTypeMismatch: Attributes in attribute pairs must have the same attribute type.
    • \r\n
  • attributeTypeNotSupported: Attribute type is not supported in smart link group attribute pairs. Attribute types supported in attribute pairs: discrete, dateTime, integer, logical, shortText.
    • \r\n
  • noAttributePairs: Smart record link group must have at least one attribute pair set.
    • \r\n
  • noSuchAttribute: Attribute not found.
    • \r\n
  • sourceCannotBeTarget: An attribute is not permitted to link to itself as both a source and target attribute.
    • \r\n
  • tooManyAttributePairs: Smart record link group cannot have more than three attribute pairs set.
    • \r\n
\r\n" - }, - "GsaSmartAttributesRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "The attributes used as linking attribute pairs for a smart link group are not valid.\r\nSee \"errors\" for details.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'smartAttributes'", - "x-discriminator-value": "smartAttributes", - "x-discriminator-name": "reason" + "description": "Unit system stripped down to its basic fields (mappings excluded)." }, - "GsaSmartLink": { + "GsaSmtpProperties": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" + "properties": { + "hostName": { + "type": "string", + "description": "Gets or sets the name of the host used for SMTP transactions", + "nullable": true }, - { - "required": [ - "attributePairs", - "forbidOrphans", - "referentialIntegrityModel" - ], - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeLinkPair" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smartLink'", - "x-discriminator-value": "smartLink", - "x-discriminator-name": "type" - }, - "GsaSmartLinkCreatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCreatePutLayoutItem" + "port": { + "type": "integer", + "description": "Gets or sets the port used for SMTP transactions.\r\nIf no value set then it will default to 25", + "format": "int32", + "default": 25 }, - { - "required": [ - "linkGroupGuid" - ], - "type": "object", - "properties": { - "forwards": { - "type": "boolean" - }, - "linkGroupGuid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCreatePutLayoutItem](#model-GsaCreatePutLayoutItem)\r\n\r\nThe value of discriminator property ('itemType') must be equal to 'smartLink'", - "x-discriminator-value": "smartLink", - "x-discriminator-name": "itemType" - }, - "GsaSmartLinkGroupUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" + "useSsl": { + "type": "boolean", + "description": "Indicates whether the SMTP server uses SSL.\r\nDefaults to False" }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'smartLinkGroup'", - "x-discriminator-value": "smartLinkGroup", - "x-discriminator-name": "referencedByType" - }, - "GsaSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroup" + "useAuthentication": { + "type": "boolean", + "description": "Indicates whether authentication is required. If this is set to True\r\nthen Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationUsername and Granta.Server.Api.ServerManager.SmtpProperties.AuthenticationPassword\r\nare required.\r\nDefaults to False" }, - { - "required": [ - "attributePairs", - "forbidOrphans", - "referentialIntegrityModel" - ], - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeLinkPair" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, - "GsaSmartRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" + "authenticationUsername": { + "type": "string", + "description": "Gets or sets the username to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True.", + "nullable": true }, - { - "required": [ - "isLinkToTarget" - ], - "type": "object", - "properties": { - "isLinkToTarget": { - "type": "boolean", - "description": "Smart links have a 'source' and a 'target' determined by the attribute pairs on the link group. If this property is 'true' then the linked record is on the 'target' side of the link, if 'false' the linked record is on the 'source' side.." - } - } + "authenticationPassword": { + "type": "string", + "description": "Gets or sets the password to use for authentication, should be set if Granta.Server.Api.ServerManager.SmtpProperties.UseAuthentication is True.", + "nullable": true } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "recordLinkGroupType" + }, + "additionalProperties": false }, "GsaSortCriterion": { "required": [ @@ -115285,7 +84550,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaAttributeSortCriterion](#model-GsaAttributeSortCriterion)\r\n * [GsaRecordPropertySortCriterion](#model-GsaRecordPropertySortCriterion)\r\n * [GsaRelevanceSortCriterion](#model-GsaRelevanceSortCriterion)", + "description": "\r\n\r\nThis is one of: \r\n * GsaAttributeSortCriterion\r\n * GsaRecordPropertySortCriterion\r\n * GsaRelevanceSortCriterion", "discriminator": { "propertyName": "type", "mapping": { @@ -115329,7 +84594,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaDoubleSortingValue](#model-GsaDoubleSortingValue)\r\n * [GsaLongSortingValue](#model-GsaLongSortingValue)\r\n * [GsaStringSortingValue](#model-GsaStringSortingValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaDoubleSortingValue\r\n * GsaLongSortingValue\r\n * GsaStringSortingValue", "discriminator": { "propertyName": "type", "mapping": { @@ -115347,21 +84612,6 @@ ], "type": "string" }, - "GsaSourceCannotBeTargetSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "An attribute is not permitted to link to itself as both a source and target attribute.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'sourceCannotBeTarget'", - "x-discriminator-value": "sourceCannotBeTarget", - "x-discriminator-name": "reason" - }, "GsaSourceOfObjectIdentifier": { "required": [ "mappings", @@ -115419,35 +84669,16 @@ } ], "additionalProperties": false, - "description": "Specifies identities or guids to filter on.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: [GsaValueSpecifier](#model-GsaValueSpecifier)\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'specific'", + "description": "Specifies identities or guids to filter on.\r\nOnly one of identities or guids should be specified.\r\n\r\nThis extends: GsaValueSpecifier\r\n\r\nThe value of discriminator property ('filterOn') must be equal to 'specific'", "x-discriminator-value": "specific", "x-discriminator-name": "filterOn" }, - "GsaSqlCredentials": { - "required": [ - "password", - "username" - ], - "type": "object", - "properties": { - "username": { - "type": "string", - "description": "The username for the SQL authentication. The password must also be provided." - }, - "password": { - "type": "string", - "description": "The password for the SQL authentication. The username must also be provided." - } - }, - "additionalProperties": false - }, "GsaStandardName": { "required": [ "databaseGuid", "databaseKey", "databaseVersionGuid", "guid", - "isCustom", "mappedAttributes", "mappedCrossDatabaseRecordLinkGroups", "mappedParameters", @@ -115491,9 +84722,6 @@ "type": "string", "format": "uuid" }, - "isCustom": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -115504,159 +84732,6 @@ }, "additionalProperties": false }, - "GsaStandardNameAlreadyExistsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "standardName" - ], - "type": "object", - "properties": { - "standardName": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'standardNameAlreadyExists'", - "x-discriminator-value": "standardNameAlreadyExists", - "x-discriminator-name": "reason" - }, - "GsaStandardNameCreationException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaStandardNameDeletionErrorDetail": { - "required": [ - "message" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaStandardNameDeletionErrorReason" - } - }, - "additionalProperties": false - }, - "GsaStandardNameDeletionErrorReason": { - "enum": [ - "nonCustomStandardNameCannotBeDeleted" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • nonCustomStandardNameCannotBeDeleted: Cannot delete a non-custom standard name.
    • \r\n
\r\n" - }, - "GsaStandardNameDeletionException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameDeletionErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaStandardNameErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaStandardNameErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaStandardNameAlreadyExistsErrorDetail](#model-GsaStandardNameAlreadyExistsErrorDetail)\r\n * [GsaDuplicateMappedAttributeGuidsErrorDetail](#model-GsaDuplicateMappedAttributeGuidsErrorDetail)\r\n * [GsaDuplicateMappedParameterGuidsErrorDetail](#model-GsaDuplicateMappedParameterGuidsErrorDetail)\r\n * [GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail](#model-GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail)\r\n * [GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail](#model-GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail)\r\n * [GsaUnresolvedAttributeGuidsErrorDetail](#model-GsaUnresolvedAttributeGuidsErrorDetail)\r\n * [GsaUnresolvedParameterGuidsErrorDetail](#model-GsaUnresolvedParameterGuidsErrorDetail)\r\n * [GsaUnresolvedRecordLinkGroupGuidsErrorDetail](#model-GsaUnresolvedRecordLinkGroupGuidsErrorDetail)\r\n * [GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail](#model-GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail)\r\n * [GsaNonCustomStandardNameCannotBeChangedErrorDetail](#model-GsaNonCustomStandardNameCannotBeChangedErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "standardNameAlreadyExists": "#/components/schemas/GsaStandardNameAlreadyExistsErrorDetail", - "duplicateMappedAttributeGuids": "#/components/schemas/GsaDuplicateMappedAttributeGuidsErrorDetail", - "duplicateMappedParameterGuids": "#/components/schemas/GsaDuplicateMappedParameterGuidsErrorDetail", - "duplicateMappedRecordLinkGroupGuids": "#/components/schemas/GsaDuplicateMappedRecordLinkGroupGuidsErrorDetail", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids": "#/components/schemas/GsaDuplicateMappedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "unresolvedAttributeGuids": "#/components/schemas/GsaUnresolvedAttributeGuidsErrorDetail", - "unresolvedParameterGuids": "#/components/schemas/GsaUnresolvedParameterGuidsErrorDetail", - "unresolvedRecordLinkGroupGuids": "#/components/schemas/GsaUnresolvedRecordLinkGroupGuidsErrorDetail", - "unresolvedCrossDatabaseRecordLinkGroupGuids": "#/components/schemas/GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail", - "nonCustomStandardNameCannotBeChanged": "#/components/schemas/GsaNonCustomStandardNameCannotBeChangedErrorDetail" - } - } - }, - "GsaStandardNameErrorReason": { - "enum": [ - "standardNameAlreadyExists", - "duplicateMappedAttributeGuids", - "duplicateMappedParameterGuids", - "duplicateMappedRecordLinkGroupGuids", - "duplicateMappedCrossDatabaseRecordLinkGroupGuids", - "unresolvedAttributeGuids", - "unresolvedParameterGuids", - "unresolvedRecordLinkGroupGuids", - "unresolvedCrossDatabaseRecordLinkGroupGuids", - "nonCustomStandardNameCannotBeChanged" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • standardNameAlreadyExists: A standard name with this name already exists.
    • \r\n
  • duplicateMappedAttributeGuids: Duplicated attribute GUIDs present.
    • \r\n
  • duplicateMappedParameterGuids: Duplicated parameter GUIDs present.
    • \r\n
  • duplicateMappedRecordLinkGroupGuids: Duplicated record link group GUIDs present.
    • \r\n
  • duplicateMappedCrossDatabaseRecordLinkGroupGuids: Duplicated cross-database record link group GUIDs present.
    • \r\n
  • unresolvedAttributeGuids: Attribute GUIDs did not resolve.
    • \r\n
  • unresolvedParameterGuids: Parameter GUIDs did not resolve.
    • \r\n
  • unresolvedRecordLinkGroupGuids: Record link group GUIDs did not resolve.
    • \r\n
  • unresolvedCrossDatabaseRecordLinkGroupGuids: Cross-database record link group GUIDs did not resolve.
    • \r\n
  • nonCustomStandardNameCannotBeChanged: The name of a 'non-custom' standard name cannot be changed.
    • \r\n
\r\n" - }, - "GsaStandardNameUpdateException": { - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaStandardNamesInfo": { "type": "object", "properties": { @@ -115670,21 +84745,6 @@ }, "additionalProperties": false }, - "GsaStaticRecordLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkBase" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkBase](#model-GsaRecordLinkBase)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'static'", - "x-discriminator-value": "static", - "x-discriminator-name": "recordLinkGroupType" - }, "GsaStaticRecordLinkGroup": { "type": "object", "allOf": [ @@ -115704,31 +84764,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkGroup](#model-GsaRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "description": "\r\n\r\nThis extends: GsaRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", "x-discriminator-value": "static", "x-discriminator-name": "type" }, - "GsaStaticRecordLinkResult": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkResult" - }, - { - "type": "object", - "properties": { - "notes": { - "type": "string", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaRecordLinkResult](#model-GsaRecordLinkResult)\r\n\r\nThe value of discriminator property ('recordLinkGroupType') must be equal to 'static'", - "x-discriminator-value": "static", - "x-discriminator-name": "recordLinkGroupType" - }, "GsaStringSortingValue": { "type": "object", "allOf": [ @@ -115746,7 +84785,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaSortingValue](#model-GsaSortingValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", + "description": "\r\n\r\nThis extends: GsaSortingValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'text'", "x-discriminator-value": "text", "x-discriminator-name": "type" }, @@ -115763,80 +84802,36 @@ }, "displayNames": { "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaSubsetsInfo": { - "type": "object", - "properties": { - "subsets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimSubset" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaSwapNameAndReverseNameCircularRecordLinkGroupErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaRecordLinkGroupErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Cannot swap name and reverse name when the source and target table are the same.\r\n\r\nThis extends: [GsaRecordLinkGroupErrorDetail](#model-GsaRecordLinkGroupErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'swapNameAndReverseNameCircular'", - "x-discriminator-value": "swapNameAndReverseNameCircular", - "x-discriminator-name": "reason" - }, - "GsaSymbolCannotContainCommaUnitErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - { - "required": [ - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - } + "additionalProperties": { + "type": "string", + "nullable": true } + }, + "name": { + "type": "string" + }, + "guid": { + "type": "string", + "format": "uuid" } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitErrorDetail](#model-GsaUnitErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'symbolCannotContainComma'", - "x-discriminator-value": "symbolCannotContainComma", - "x-discriminator-name": "reason" + }, + "additionalProperties": false }, - "GsaTItem": { + "GsaSubsetsInfo": { "type": "object", + "properties": { + "subsets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaSlimSubset" + }, + "nullable": true + } + }, "additionalProperties": false }, "GsaTable": { "required": [ - "databaseKey", "displayNames", "guid", "isHiddenFromBrowse", @@ -115844,7 +84839,6 @@ "isVersioned", "layouts", "name", - "order", "subsets", "tableTypes", "versionState" @@ -115872,32 +84866,6 @@ "versionState": { "$ref": "#/components/schemas/GsaVersionState" }, - "order": { - "type": "integer", - "format": "int32" - }, - "qualitySystem": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean", - "description": "Gets or sets whether version control signatures should be shown when data is shown to a user.\r\n'Version control signatures' show when a record was released, who released it and on which revision." - }, - "databaseKey": { - "type": "string" - }, "isHiddenFromBrowse": { "type": "boolean" }, @@ -115918,8 +84886,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -115931,36 +84898,7 @@ }, "additionalProperties": false }, - "GsaTableCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaTableDeletionException": { - "required": [ - "guid" - ], "type": "object", "properties": { "message": { @@ -115968,12 +84906,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -115985,46 +84918,6 @@ }, "additionalProperties": false }, - "GsaTableErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaTableErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNamedEntityTableErrorDetail](#model-GsaNamedEntityTableErrorDetail)\r\n * [GsaTableTypesErrorDetail](#model-GsaTableTypesErrorDetail)\r\n * [GsaRootRecordNotAvailableToRenameErrorDetail](#model-GsaRootRecordNotAvailableToRenameErrorDetail)\r\n * [GsaDefaultSubsetGuidErrorDetail](#model-GsaDefaultSubsetGuidErrorDetail)\r\n * [GsaDefaultLayoutGuidErrorDetail](#model-GsaDefaultLayoutGuidErrorDetail)\r\n * [GsaQualitySystemGuidErrorDetail](#model-GsaQualitySystemGuidErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "namedEntity": "#/components/schemas/GsaNamedEntityTableErrorDetail", - "tableTypes": "#/components/schemas/GsaTableTypesErrorDetail", - "rootRecordNotAvailableToRename": "#/components/schemas/GsaRootRecordNotAvailableToRenameErrorDetail", - "defaultSubsetGuid": "#/components/schemas/GsaDefaultSubsetGuidErrorDetail", - "defaultLayoutGuid": "#/components/schemas/GsaDefaultLayoutGuidErrorDetail", - "qualitySystemGuid": "#/components/schemas/GsaQualitySystemGuidErrorDetail" - } - } - }, - "GsaTableErrorReason": { - "enum": [ - "namedEntity", - "tableTypes", - "rootRecordNotAvailableToRename", - "defaultSubsetGuid", - "defaultLayoutGuid", - "qualitySystemGuid" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • tableTypes: The table types are not valid.
    • \r\n
  • rootRecordNotAvailableToRename: The table cannot be renamed as the root record is not available.
    • \r\n
  • defaultSubsetGuid: The default subset guid does not represent an existing subset in the table.
    • \r\n
  • defaultLayoutGuid: The default layout guid does not represent an existing layout in the table.
    • \r\n
  • qualitySystemGuid: The quality system guid does not represent an existing quality system in the database.
    • \r\n
\r\n" - }, "GsaTableGuidProperty": { "type": "object", "allOf": [ @@ -116042,7 +84935,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableGuid'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableGuid'", "x-discriminator-value": "tableGuid", "x-discriminator-name": "propertyName" }, @@ -116063,7 +84956,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableIdentity'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableIdentity'", "x-discriminator-value": "tableIdentity", "x-discriminator-name": "propertyName" }, @@ -116084,140 +84977,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableName'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'tableName'", "x-discriminator-value": "tableName", "x-discriminator-name": "propertyName" }, - "GsaTableSearchBehaviour": { - "enum": [ - "OnlyIncludeRecordsFromSearchableTables", - "OnlyIncludeRecordsFromHiddenFromSearchTables", - "IncludeRecordsFromAllTables" - ], - "type": "string", - "description": "Enum to determine the behaviour of records in tables that are marked as searchable or not searchable

Possible values:

\r\n
    \r\n
  • OnlyIncludeRecordsFromSearchableTables: The default behaviour. Records in tables marked as \"hidden from search\" will be excluded from the results set
    • \r\n
  • OnlyIncludeRecordsFromHiddenFromSearchTables: Only records in tables marked as \"hidden from search\" will be included in the results set
    • \r\n
  • IncludeRecordsFromAllTables: Records will be included in the results set regardless of the searchability of the table
    • \r\n
\r\n" - }, - "GsaTableTypeContainsCommaErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" - }, - { - "required": [ - "tableType" - ], - "type": "object", - "properties": { - "tableType": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableTypeErrorDetail](#model-GsaTableTypeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tableTypeContainsComma'", - "x-discriminator-value": "tableTypeContainsComma", - "x-discriminator-name": "reason" - }, - "GsaTableTypeErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaTableTypeErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEmptyTableTypeErrorDetail](#model-GsaEmptyTableTypeErrorDetail)\r\n * [GsaTableTypeContainsCommaErrorDetail](#model-GsaTableTypeContainsCommaErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "emptyTableType": "#/components/schemas/GsaEmptyTableTypeErrorDetail", - "tableTypeContainsComma": "#/components/schemas/GsaTableTypeContainsCommaErrorDetail" - } - } - }, - "GsaTableTypeErrorReason": { - "enum": [ - "emptyTableType", - "tableTypeContainsComma" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • emptyTableType: A table type cannot be empty or whitespace.
    • \r\n
  • tableTypeContainsComma: A table type cannot contain a comma.
    • \r\n
\r\n" - }, - "GsaTableTypesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTableTypeErrorDetail" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTableErrorDetail](#model-GsaTableErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tableTypes'", - "x-discriminator-value": "tableTypes", - "x-discriminator-name": "reason" - }, - "GsaTableTypesInfo": { - "type": "object", - "properties": { - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaTableUpdateException": { - "required": [ - "tableGuid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTableErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, "GsaTablesInfo": { "type": "object", "properties": { @@ -116268,33 +85031,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttribute](#model-GsaAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\nThis extends: GsaAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, - "GsaTabularAttributeLink": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaLink" - }, - { - "required": [ - "targetAttribute" - ], - "type": "object", - "properties": { - "targetAttribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaLink](#model-GsaLink)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularAttribute'", - "x-discriminator-value": "tabularAttribute", - "x-discriminator-name": "type" - }, "GsaTabularAttributeTarget": { "type": "object", "properties": { @@ -116337,7 +85077,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularAttribute'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularAttribute'", "x-discriminator-value": "tabularAttribute", "x-discriminator-name": "referencedByType" }, @@ -116366,13 +85106,11 @@ "displayNames", "guid", "name", - "order", "rollUpType", "showAsLink", "summaryRowEnabled", "summaryRowRollUpType", - "summaryRowText", - "summaryRowTranslations" + "summaryRowText" ], "type": "object", "properties": { @@ -116388,19 +85126,6 @@ "summaryRowText": { "type": "string" }, - "summaryRowTranslations": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the row text that should be used in that culture for the item" - }, - "order": { - "type": "integer", - "description": "The order that this column appears in the tabular attribute. Columns on an attribute object are returned from the API in the correct sorted order.", - "format": "int32" - }, "rollUpType": { "$ref": "#/components/schemas/GsaTabularColumnRollUpType" }, @@ -116412,8 +85137,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -116424,7 +85148,7 @@ } }, "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaLinkedAttributeTabularColumn](#model-GsaLinkedAttributeTabularColumn)\r\n * [GsaLinkedColumnTabularColumn](#model-GsaLinkedColumnTabularColumn)\r\n * [GsaLinkedRecordTabularColumn](#model-GsaLinkedRecordTabularColumn)\r\n * [GsaLocalPointTabularColumn](#model-GsaLocalPointTabularColumn)\r\n * [GsaLocalRangeTabularColumn](#model-GsaLocalRangeTabularColumn)\r\n * [GsaLocalIntegerTabularColumn](#model-GsaLocalIntegerTabularColumn)\r\n * [GsaLocalLogicalTabularColumn](#model-GsaLocalLogicalTabularColumn)\r\n * [GsaLocalShortTextTabularColumn](#model-GsaLocalShortTextTabularColumn)\r\n * [GsaLocalLongTextTabularColumn](#model-GsaLocalLongTextTabularColumn)\r\n * [GsaLocalDateTimeTabularColumn](#model-GsaLocalDateTimeTabularColumn)\r\n * [GsaLocalDiscreteTabularColumn](#model-GsaLocalDiscreteTabularColumn)\r\n * [GsaLocalHyperlinkTabularColumn](#model-GsaLocalHyperlinkTabularColumn)\r\n * [GsaLocalFileTabularColumn](#model-GsaLocalFileTabularColumn)\r\n * [GsaLocalPictureTabularColumn](#model-GsaLocalPictureTabularColumn)\r\n * [GsaUnavailableTabularColumn](#model-GsaUnavailableTabularColumn)", + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaLinkedAttributeTabularColumn\r\n * GsaLinkedColumnTabularColumn\r\n * GsaLinkedRecordTabularColumn\r\n * GsaLocalPointTabularColumn\r\n * GsaLocalRangeTabularColumn\r\n * GsaLocalIntegerTabularColumn\r\n * GsaLocalLogicalTabularColumn\r\n * GsaLocalShortTextTabularColumn\r\n * GsaLocalLongTextTabularColumn\r\n * GsaLocalDateTimeTabularColumn\r\n * GsaLocalDiscreteTabularColumn\r\n * GsaLocalHyperlinkTabularColumn\r\n * GsaLocalFileTabularColumn\r\n * GsaLocalPictureTabularColumn\r\n * GsaUnavailableTabularColumn", "discriminator": { "propertyName": "columnType", "mapping": { @@ -116488,7 +85212,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNameNotProvided'", + "description": "\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tabularColumnNameNotProvided'", "x-discriminator-value": "tabularColumnNameNotProvided", "x-discriminator-name": "reason" }, @@ -116516,30 +85240,6 @@ "type": "string", "description": "The roll up types of a tabular column." }, - "GsaTabularColumnUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaTabularAttributeWithColumns" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'tabularColumn'", - "x-discriminator-value": "tabularColumn", - "x-discriminator-name": "referencedByType" - }, "GsaTabularDatum": { "type": "object", "allOf": [ @@ -116565,7 +85265,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaApplicableDatum](#model-GsaApplicableDatum)\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'tabular'", + "description": "\r\n\r\nThis extends: GsaApplicableDatum\r\n\r\nThe value of discriminator property ('datumType') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "datumType" }, @@ -116596,7 +85296,7 @@ } ], "additionalProperties": false, - "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: [GsaDatumExistsCriterion](#model-GsaDatumExistsCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabular'", + "description": "Inner criterion of an attribute exists search criterion for when the only bit of information about the datum that we want to convey is its type\r\n\r\nThis extends: GsaDatumExistsCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabular'", "x-discriminator-value": "tabular", "x-discriminator-name": "type" }, @@ -116679,7 +85379,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaCriterion](#model-GsaCriterion)\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularLinkingValue'", + "description": "\r\n\r\nThis extends: GsaCriterion\r\n\r\nThe value of discriminator property ('type') must be equal to 'tabularLinkingValue'", "x-discriminator-value": "tabularLinkingValue", "x-discriminator-name": "type" }, @@ -116691,31 +85391,6 @@ "type": "string", "description": "

Possible values:

\r\n
    \r\n
  • allRows: Export all rows - including rows with no visible linked records
    • \r\n
  • onlyRowsWithVisibleLinkedRecords: Export only rows with visible linked records
    • \r\n
\r\n" }, - "GsaTargetAttribute": { - "required": [ - "guid", - "targetType" - ], - "type": "object", - "properties": { - "targetType": { - "$ref": "#/components/schemas/GsaTargetAttributeType" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaResolvedTargetAttribute](#model-GsaResolvedTargetAttribute)\r\n * [GsaUnresolvedTargetAttribute](#model-GsaUnresolvedTargetAttribute)", - "discriminator": { - "propertyName": "targetType", - "mapping": { - "resolved": "#/components/schemas/GsaResolvedTargetAttribute", - "unresolved": "#/components/schemas/GsaUnresolvedTargetAttribute" - } - } - }, "GsaTargetAttributeNotInTableAttributeErrorDetail": { "type": "object", "allOf": [ @@ -116737,17 +85412,10 @@ } ], "additionalProperties": false, - "description": "The target attribute is not valid as it does not belong to the target table.\r\nTabular attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeNotInTable'", + "description": "The target attribute is not valid as it does not belong to the target table.\r\nTabular attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeNotInTable'", "x-discriminator-value": "targetAttributeNotInTable", "x-discriminator-name": "reason" }, - "GsaTargetAttributeType": { - "enum": [ - "resolved", - "unresolved" - ], - "type": "string" - }, "GsaTargetAttributeTypeAttributeErrorDetail": { "type": "object", "allOf": [ @@ -116765,7 +85433,7 @@ } ], "additionalProperties": false, - "description": "The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute.\r\nTabular attributes only.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeType'", + "description": "The target attribute is not valid as the target attribute of a tabular attribute as it is not a short text attribute.\r\nTabular attributes only.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'targetAttributeType'", "x-discriminator-value": "targetAttributeType", "x-discriminator-name": "reason" }, @@ -116800,276 +85468,27 @@ }, { "type": "object", - "properties": { - "thresholdType": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "attributeType": { - "$ref": "#/components/schemas/GsaAttributeType" - }, - "allowedThresholdTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaAttributeThresholdType" - }, - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Threshold type is not allowed for this attribute type.\r\n\r\nThis extends: [GsaAttributeErrorDetail](#model-GsaAttributeErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdType'", - "x-discriminator-value": "thresholdType", - "x-discriminator-name": "reason" - }, - "GsaTooLongCodeCurrencyErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaCurrencyErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "Currency code cannot be longer than 3 characters.\r\n\r\nThis extends: [GsaCurrencyErrorDetail](#model-GsaCurrencyErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooLongCode'", - "x-discriminator-value": "tooLongCode", - "x-discriminator-name": "reason" - }, - "GsaTooManyAttributePairsSmartAttributesErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaSmartAttributesErrorDetail" - }, - { - "required": [ - "numberOfAttributePairs" - ], - "type": "object", - "properties": { - "numberOfAttributePairs": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "Smart record link group cannot have more than three attribute pairs set.\r\n\r\nThis extends: [GsaSmartAttributesErrorDetail](#model-GsaSmartAttributesErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyAttributePairs'", - "x-discriminator-value": "tooManyAttributePairs", - "x-discriminator-name": "reason" - }, - "GsaTooManyPermissionsPermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPermissionCategoryErrorDetail" - }, - { - "required": [ - "maxNumberOfPermissions", - "numberOfNewPermissions" - ], - "type": "object", - "properties": { - "numberOfNewPermissions": { - "type": "integer", - "format": "int32" - }, - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "The new permissions cannot be added, there are not enough permissions available.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaPermissionCategoryErrorDetail](#model-GsaPermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyPermissions'", - "x-discriminator-value": "tooManyPermissions", - "x-discriminator-name": "reason" - }, - "GsaTooManyPermissionsReplacePermissionCategoryErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaReplacePermissionCategoryErrorDetail" - }, - { - "required": [ - "maxNumberOfPermissions", - "numberOfNewPermissions" - ], - "type": "object", - "properties": { - "numberOfNewPermissions": { - "type": "integer", - "format": "int32" - }, - "maxNumberOfPermissions": { - "type": "integer", - "format": "int32" - } - } - } - ], - "additionalProperties": false, - "description": "The new permissions cannot be added, there are not enough permissions available.\r\nA schema for a database may have up to 128 permissions.\r\nThis is the total number of permissions that have ever existed in the schema\r\n\r\nThis extends: [GsaReplacePermissionCategoryErrorDetail](#model-GsaReplacePermissionCategoryErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'tooManyPermissions'", - "x-discriminator-value": "tooManyPermissions", - "x-discriminator-name": "reason" - }, - "GsaTranslateBetweenGuidsAndIdentitiesResponse": { - "required": [ - "databaseKey" - ], - "type": "object", - "properties": { - "databaseKey": { - "type": "string" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "layouts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordVersions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordHistories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "unitSystems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "subsets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "discreteTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "discreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "replacementStrings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "standardNames": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "constants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "recordLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" - }, - "nullable": true + "properties": { + "thresholdType": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "attributeType": { + "$ref": "#/components/schemas/GsaAttributeType" + }, + "allowedThresholdTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaAttributeThresholdType" + }, + "nullable": true + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "Threshold type is not allowed for this attribute type.\r\n\r\nThis extends: GsaAttributeErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'thresholdType'", + "x-discriminator-value": "thresholdType", + "x-discriminator-name": "reason" }, "GsaTranslateGuidsToIdentitiesRequest": { "required": [ @@ -117185,45 +85604,17 @@ }, "nullable": true }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimEntity" }, "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "nullable": true } }, "additionalProperties": false }, - "GsaTranslateIdentitiesToGuidsRequest": { + "GsaTranslateGuidsToIdentitiesResponse": { "required": [ "databaseKey" ], @@ -117235,160 +85626,112 @@ "attributes": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "layouts": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordVersions": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordHistories": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "units": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "unitSystems": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "parameters": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "subsets": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "tables": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "discreteTypes": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "discreteValues": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "replacementStrings": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "standardNames": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "constants": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "recordLinkGroups": { "type": "array", "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "crossDatabaseLinkGroups": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "tabularColumns": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true }, "data": { "type": "array", "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "searchMasks": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "nullable": true - }, - "searchTemplates": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/GsaSlimIdentifiedEntity" }, "nullable": true } @@ -117414,7 +85757,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaAddDatabaseValidationIssue](#model-GsaAddDatabaseValidationIssue)\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'unableToConnect'", + "description": "\r\n\r\nThis extends: GsaAddDatabaseValidationIssue\r\n\r\nThe value of discriminator property ('IssueType') must be equal to 'unableToConnect'", "x-discriminator-value": "unableToConnect", "x-discriminator-name": "IssueType" }, @@ -117429,7 +85772,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTabularColumn](#model-GsaTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", + "description": "\r\n\r\nThis extends: GsaTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", "x-discriminator-value": "unavailable", "x-discriminator-name": "columnType" }, @@ -117462,21 +85805,6 @@ }, "additionalProperties": false }, - "GsaUnitAsExponentUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unitAsExponent'", - "x-discriminator-value": "unitAsExponent", - "x-discriminator-name": "reason" - }, "GsaUnitConversionSet": { "required": [ "factor", @@ -117511,12 +85839,10 @@ "type": "object", "properties": { "sourceUnitSymbol": { - "type": "string", - "description": "Symbol of the unit to convert from\r\nIf the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code" + "type": "string" }, "targetUnitSymbol": { - "type": "string", - "description": "Symbol of the unit to convert from\r\nIf the unit contains a currency, this can be unresolved (i.e. as the \"currency\" string), or resolved to the three letter currency code" + "type": "string" } }, "additionalProperties": false @@ -117545,100 +85871,6 @@ "additionalProperties": false, "description": "Represents a set of unit conversions for each source unit.\r\nFailures are included alongside the conversions for any source units that could not be converted." }, - "GsaUnitCreationException": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "name": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitDeletionException": { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid", - "readOnly": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaDataModificationErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitEquationErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitEquationErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaGeneralUnitEquationErrorDetail](#model-GsaGeneralUnitEquationErrorDetail)\r\n * [GsaUnknownUnitSymbolUnitEquationErrorDetail](#model-GsaUnknownUnitSymbolUnitEquationErrorDetail)\r\n * [GsaBracketMismatchUnitEquationErrorDetail](#model-GsaBracketMismatchUnitEquationErrorDetail)\r\n * [GsaNumberParsingUnitEquationErrorDetail](#model-GsaNumberParsingUnitEquationErrorDetail)\r\n * [GsaUnitAsExponentUnitEquationErrorDetail](#model-GsaUnitAsExponentUnitEquationErrorDetail)\r\n * [GsaDivideByZeroUnitEquationErrorDetail](#model-GsaDivideByZeroUnitEquationErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "general": "#/components/schemas/GsaGeneralUnitEquationErrorDetail", - "unknownUnitSymbol": "#/components/schemas/GsaUnknownUnitSymbolUnitEquationErrorDetail", - "bracketMismatch": "#/components/schemas/GsaBracketMismatchUnitEquationErrorDetail", - "numberParsing": "#/components/schemas/GsaNumberParsingUnitEquationErrorDetail", - "unitAsExponent": "#/components/schemas/GsaUnitAsExponentUnitEquationErrorDetail", - "divideByZero": "#/components/schemas/GsaDivideByZeroUnitEquationErrorDetail" - } - } - }, - "GsaUnitEquationErrorReason": { - "enum": [ - "general", - "unknownUnitSymbol", - "bracketMismatch", - "numberParsing", - "unitAsExponent", - "divideByZero" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • general: The equation is not valid.
    • \r\n
  • unknownUnitSymbol: Unknown unit in equation.
    • \r\n
  • bracketMismatch: Mismatched brackets in unit equation.
    • \r\n
  • numberParsing: Error parsing number in unit equation.
    • \r\n
  • unitAsExponent: Cannot raise to the power of a unit.
    • \r\n
  • divideByZero: Cannot divide by zero.
    • \r\n
\r\n" - }, "GsaUnitEquivalent": { "required": [ "equivalentUnit", @@ -117648,53 +85880,17 @@ "type": "object", "properties": { "unit": { - "$ref": "#/components/schemas/GsaSlimEntity" + "$ref": "#/components/schemas/GsaUnit" }, "unitSystem": { - "$ref": "#/components/schemas/GsaSlimEntity" + "$ref": "#/components/schemas/GsaUnitSystem" }, "equivalentUnit": { - "$ref": "#/components/schemas/GsaSlimUnit" + "$ref": "#/components/schemas/GsaUnit" } }, "additionalProperties": false }, - "GsaUnitEquivalentErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitEquivalentErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaNoSuchUnitUnitEquivalentErrorDetail](#model-GsaNoSuchUnitUnitEquivalentErrorDetail)\r\n * [GsaNoSuchUnitSystemUnitEquivalentErrorDetail](#model-GsaNoSuchUnitSystemUnitEquivalentErrorDetail)\r\n * [GsaIncompatibleUnitsErrorDetail](#model-GsaIncompatibleUnitsErrorDetail)\r\n * [GsaInvalidEquivalenceTargetErrorDetail](#model-GsaInvalidEquivalenceTargetErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "noSuchUnit": "#/components/schemas/GsaNoSuchUnitUnitEquivalentErrorDetail", - "noSuchUnitSystem": "#/components/schemas/GsaNoSuchUnitSystemUnitEquivalentErrorDetail", - "incompatibleUnits": "#/components/schemas/GsaIncompatibleUnitsErrorDetail", - "invalidEquivalenceTarget": "#/components/schemas/GsaInvalidEquivalenceTargetErrorDetail" - } - } - }, - "GsaUnitEquivalentErrorReason": { - "enum": [ - "noSuchUnit", - "noSuchUnitSystem", - "incompatibleUnits", - "invalidEquivalenceTarget" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • noSuchUnit: Could not find the unit with the given GUID.
    • \r\n
  • noSuchUnitSystem: Could not find the unit system with the given GUID.
    • \r\n
  • incompatibleUnits: Could not set a unit equivalent as the unit was incompatible with the equivalent unit.
    • \r\n
  • invalidEquivalenceTarget: Could not set a unit equivalent as the equivalent unit is itself equivalent to another unit.
    • \r\n
\r\n" - }, "GsaUnitEquivalentsInfo": { "type": "object", "properties": { @@ -117708,44 +85904,6 @@ }, "additionalProperties": false }, - "GsaUnitErrorDetail": { - "required": [ - "message", - "reason" - ], - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "reason": { - "$ref": "#/components/schemas/GsaUnitErrorReason" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaEmptySymbolUnitErrorDetail](#model-GsaEmptySymbolUnitErrorDetail)\r\n * [GsaDuplicateSymbolUnitErrorDetail](#model-GsaDuplicateSymbolUnitErrorDetail)\r\n * [GsaSymbolCannotContainCommaUnitErrorDetail](#model-GsaSymbolCannotContainCommaUnitErrorDetail)\r\n * [GsaNamedEntityUnitErrorDetail](#model-GsaNamedEntityUnitErrorDetail)\r\n * [GsaEquationUnitErrorDetail](#model-GsaEquationUnitErrorDetail)", - "discriminator": { - "propertyName": "reason", - "mapping": { - "emptySymbol": "#/components/schemas/GsaEmptySymbolUnitErrorDetail", - "duplicateSymbol": "#/components/schemas/GsaDuplicateSymbolUnitErrorDetail", - "symbolCannotContainComma": "#/components/schemas/GsaSymbolCannotContainCommaUnitErrorDetail", - "namedEntity": "#/components/schemas/GsaNamedEntityUnitErrorDetail", - "equation": "#/components/schemas/GsaEquationUnitErrorDetail" - } - } - }, - "GsaUnitErrorReason": { - "enum": [ - "emptySymbol", - "duplicateSymbol", - "symbolCannotContainComma", - "namedEntity", - "equation" - ], - "type": "string", - "description": "

Possible values:

\r\n
    \r\n
  • emptySymbol: Unit must have a symbol
    • \r\n
  • duplicateSymbol: A unit with the symbol already exists.
    • \r\n
  • symbolCannotContainComma: Unit symbol cannot contain a comma.
    • \r\n
  • namedEntity: The name or GUID is not valid.
    • \r\n
  • equation: The equation is not valid.
    • \r\n
\r\n" - }, "GsaUnitMapping": { "required": [ "equivalentUnit", @@ -117782,8 +85940,7 @@ "additionalProperties": { "type": "string", "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" + } }, "name": { "type": "string" @@ -117802,128 +85959,53 @@ "unitSystems": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimLocalizedEntity" + "$ref": "#/components/schemas/GsaSlimUnitSystem" }, "nullable": true } }, "additionalProperties": false }, - "GsaUnitUpdateException": { + "GsaUnitUsage": { "required": [ - "guid" + "attributes", + "constants", + "expressions", + "parameters", + "units" ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "guid": { - "type": "string", - "format": "uuid" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitUsage": { "type": "object", "properties": { "attributes": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimAttribute" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + } }, "constants": { "type": "array", "items": { "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true + } }, "expressions": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaSlimExpression" - }, - "nullable": true + "$ref": "#/components/schemas/GsaSlimNamedEntity" + } }, "units": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnit" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnitUsageDataModificationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUsageDataModificationErrorDetail" - }, - { - "type": "object", - "properties": { - "referencedBy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimNamedEntity" - }, - "nullable": true - } + "$ref": "#/components/schemas/GsaSlimUnit" } } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'unit'", - "x-discriminator-value": "unit", - "x-discriminator-name": "referencedByType" - }, - "GsaUnitUsageType": { - "enum": [ - "attributes", - "parameters", - "constants", - "expressions", - "units" - ], - "type": "string" - }, - "GsaUnitsGroupingInfo": { - "type": "object", - "properties": { - "unitGroups": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimUnit" - } - }, - "nullable": true - } }, "additionalProperties": false }, @@ -117933,214 +86015,7 @@ "units": { "type": "array", "items": { - "$ref": "#/components/schemas/GsaUnit" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUnknownUnitSymbolUnitEquationErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - { - "required": [ - "symbol" - ], - "type": "object", - "properties": { - "symbol": { - "type": "string" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUnitEquationErrorDetail](#model-GsaUnitEquationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unknownUnitSymbol'", - "x-discriminator-value": "unknownUnitSymbol", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedAttributeGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedAttributeGuids'", - "x-discriminator-value": "unresolvedAttributeGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedCrossDatabaseRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedCrossDatabaseRecordLinkGroupGuids'", - "x-discriminator-value": "unresolvedCrossDatabaseRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedParameterGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedParameterGuids'", - "x-discriminator-value": "unresolvedParameterGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedRecordLinkGroupGuidsErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaStandardNameErrorDetail" - }, - { - "required": [ - "unresolvedGuids" - ], - "type": "object", - "properties": { - "unresolvedGuids": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - } - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaStandardNameErrorDetail](#model-GsaStandardNameErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'unresolvedRecordLinkGroupGuids'", - "x-discriminator-value": "unresolvedRecordLinkGroupGuids", - "x-discriminator-name": "reason" - }, - "GsaUnresolvedTargetAttribute": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaTargetAttribute" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaTargetAttribute](#model-GsaTargetAttribute)\r\n\r\nThe value of discriminator property ('targetType') must be equal to 'unresolved'", - "x-discriminator-value": "unresolved", - "x-discriminator-name": "targetType" - }, - "GsaUpdateAccessControl": { - "required": [ - "mode" - ], - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/GsaAccessControlMode" - } - }, - "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdatePermissionBasedAccessControl](#model-GsaUpdatePermissionBasedAccessControl)\r\n * [GsaUpdateAttributeBasedAccessControl](#model-GsaUpdateAttributeBasedAccessControl)", - "discriminator": { - "propertyName": "mode", - "mapping": { - "permissionBased": "#/components/schemas/GsaUpdatePermissionBasedAccessControl", - "attributeBased": "#/components/schemas/GsaUpdateAttributeBasedAccessControl" - } - } - }, - "GsaUpdateAccessControlCategory": { - "type": "object", - "properties": { - "tableMappings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateAccessControlCategoryTableMapping" - } - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaUpdateAccessControlCategoryTableMapping": { - "required": [ - "table" - ], - "type": "object", - "properties": { - "table": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "attribute": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "tableDiscreteValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaSlimEntity" + "$ref": "#/components/schemas/GsaSlimNamedUnit" }, "nullable": true } @@ -118191,15 +86066,6 @@ "description": "If true, the attribute should not be shown in search UIs.\r\nIt will still be included in text searches.\r\nIf not specified, it will be set to the default value for the attribute type.", "nullable": true }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "Set a display name for different languages.\r\nSupported languages include, but are not limited to, \"en\", \"fr\", \"de\", \"ru\", \"ko\", \"zh-CN\", \"ja\".", - "nullable": true - }, "name": { "type": "string" }, @@ -118209,7 +86075,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\ndefaultThresholdType: The default threshold type for this attribute when used in searching. Allowed values depend on the attribute type as follows: - shortText: exists, doesNotExist, equal, contains, none - longText, file, hyperlink: exists, doesNotExist, contains, none - logical: exists, doesNotExist, equal, none - picture, link, tabular: exists, doesNotExist, none - point, range, integer, date, floatFunctional, mathsFunctional: exists, doesNotExist, atLeast, atMost, equal, between, none - discrete: exists, doesNotExist, atLeast, atMost, equal, isOneOf, isNot, isAllOf, none - discreteFunctional: exists, doesNotExist, atLeast, atMost, equal, isOneOf, none\r\n\r\nThis is one of: \r\n * [GsaUpdatePointAttribute](#model-GsaUpdatePointAttribute)\r\n * [GsaUpdateIntegerAttribute](#model-GsaUpdateIntegerAttribute)\r\n * [GsaUpdateRangeAttribute](#model-GsaUpdateRangeAttribute)\r\n * [GsaUpdateLogicalAttribute](#model-GsaUpdateLogicalAttribute)\r\n * [GsaUpdateShortTextAttribute](#model-GsaUpdateShortTextAttribute)\r\n * [GsaUpdateLongTextAttribute](#model-GsaUpdateLongTextAttribute)\r\n * [GsaUpdateDateTimeAttribute](#model-GsaUpdateDateTimeAttribute)\r\n * [GsaUpdateDiscreteAttribute](#model-GsaUpdateDiscreteAttribute)\r\n * [GsaUpdateHyperlinkAttribute](#model-GsaUpdateHyperlinkAttribute)\r\n * [GsaUpdateFileAttribute](#model-GsaUpdateFileAttribute)\r\n * [GsaUpdatePictureAttribute](#model-GsaUpdatePictureAttribute)\r\n * [GsaUpdateTabularAttribute](#model-GsaUpdateTabularAttribute)\r\n * [GsaUpdateFloatFunctionalAttribute](#model-GsaUpdateFloatFunctionalAttribute)\r\n * [GsaUpdateDiscreteFunctionalAttribute](#model-GsaUpdateDiscreteFunctionalAttribute)\r\n * [GsaUpdateMathsFunctionalAttribute](#model-GsaUpdateMathsFunctionalAttribute)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdatePointAttribute\r\n * GsaUpdateIntegerAttribute\r\n * GsaUpdateRangeAttribute\r\n * GsaUpdateLogicalAttribute\r\n * GsaUpdateShortTextAttribute\r\n * GsaUpdateLongTextAttribute\r\n * GsaUpdateDateTimeAttribute\r\n * GsaUpdateDiscreteAttribute\r\n * GsaUpdateHyperlinkAttribute\r\n * GsaUpdateFileAttribute\r\n * GsaUpdatePictureAttribute\r\n * GsaUpdateTabularAttribute\r\n * GsaUpdateFloatFunctionalAttribute\r\n * GsaUpdateDiscreteFunctionalAttribute\r\n * GsaUpdateMathsFunctionalAttribute", "discriminator": { "propertyName": "type", "mapping": { @@ -118231,29 +86097,6 @@ } } }, - "GsaUpdateAttributeBasedAccessControl": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateAccessControl" - }, - { - "required": [ - "updateCurrentRuleEngine" - ], - "type": "object", - "properties": { - "updateCurrentRuleEngine": { - "$ref": "#/components/schemas/GsaUpdateCurrentRuleEngine" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAccessControl](#model-GsaUpdateAccessControl)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'attributeBased'", - "x-discriminator-value": "attributeBased", - "x-discriminator-name": "mode" - }, "GsaUpdateAxisName": { "required": [ "name" @@ -118340,23 +86183,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'crossDatabase'", "x-discriminator-value": "crossDatabase", "x-discriminator-name": "type" }, - "GsaUpdateCurrentRuleEngine": { - "required": [ - "fullyQualifiedTypeName" - ], - "type": "object", - "properties": { - "fullyQualifiedTypeName": { - "type": "string", - "description": "The fully qualified name of the rule engine implementation." - } - }, - "additionalProperties": false - }, "GsaUpdateDataRule": { "type": "object", "properties": { @@ -118413,10 +86243,6 @@ "type": "string", "description": "The name of the database. Can only be edited by a database data administrator" }, - "isImplicitProfileDisabled": { - "type": "boolean", - "description": "Whether the implicit Profile for this database is disabled. Can only be edited by a database data administrator" - }, "isReadOnly": { "type": "boolean", "description": "True if the database should be set to read only. Can only be edited by a system administrator" @@ -118436,11 +86262,6 @@ "description": "The SQL server data source. Can only be edited by a system administrator", "nullable": true }, - "useConfigurationDatabaseCredentials": { - "type": "boolean", - "description": "Set to true if the SQL connection to the database should use the same credentials as connection to Configuration Database. Can only be edited by a system administrator", - "nullable": true - }, "useIntegratedSecurity": { "type": "boolean", "description": "Set to true if the SQL connection to the database should use Windows authentication. Can only be edited by a system administrator", @@ -118470,35 +86291,6 @@ "type": "integer", "description": "The MI loading order for the database. Can only be edited by a system administrator", "format": "int32" - }, - "defaultTable": { - "$ref": "#/components/schemas/GsaSlimEntity" - } - }, - "additionalProperties": false - }, - "GsaUpdateDatabaseSecurityGroups": { - "type": "object", - "properties": { - "adminGroup": { - "type": "string", - "nullable": true - }, - "grantGroup": { - "type": "string", - "nullable": true - }, - "powerUserGroup": { - "type": "string", - "nullable": true - }, - "writeGroup": { - "type": "string", - "nullable": true - }, - "readGroup": { - "type": "string", - "nullable": true } }, "additionalProperties": false @@ -118514,46 +86306,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'dateTime'", "x-discriminator-value": "dateTime", "x-discriminator-name": "type" }, - "GsaUpdateDefaultDatabase": { - "required": [ - "defaultDatabaseKey" - ], - "type": "object", - "properties": { - "defaultDatabaseKey": { - "type": "string" - } - }, - "additionalProperties": false - }, - "GsaUpdateDefaultFallbackSecurityGroups": { - "type": "object", - "properties": { - "systemGroup": { - "type": "string" - }, - "adminGroup": { - "type": "string" - }, - "grantGroup": { - "type": "string" - }, - "powerUserGroup": { - "type": "string" - }, - "writeGroup": { - "type": "string" - }, - "readGroup": { - "type": "string" - } - }, - "additionalProperties": false - }, "GsaUpdateDefaultProfile": { "required": [ "key" @@ -118583,7 +86339,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118606,7 +86362,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'discreteFunctional'", "x-discriminator-value": "discreteFunctional", "x-discriminator-name": "type" }, @@ -118626,7 +86382,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaUpdateDiscreteFunctionalAttributeParameter](#model-GsaUpdateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaUpdateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118649,7 +86405,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateDiscreteFunctionalAttributeParameter](#model-GsaUpdateDiscreteFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateDiscreteFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -118669,7 +86425,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteFunctionalAttributeDiscreteParameter](#model-GsaUpdateDiscreteFunctionalAttributeDiscreteParameter)\r\n * [GsaUpdateDiscreteFunctionalAttributeNumericParameter](#model-GsaUpdateDiscreteFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteFunctionalAttributeDiscreteParameter\r\n * GsaUpdateDiscreteFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -118685,20 +86441,11 @@ "$ref": "#/components/schemas/GsaUpdateParameter" }, { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateDiscreteParameterValue" - }, - "description": "Update the set of parameter values.\r\nThis can result in adding, modifying, deleting and reordering parameter values.\r\nExisting parameter values will be matched by GUID.\r\nIf an existing parameter value is not included, it will be deleted.\r\nIf a GUID is not provided, or the GUID does not match an existing value, a new value will be created.\r\nNew values must have a name." - } - } + "type": "object" } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameter](#model-GsaUpdateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118721,7 +86468,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterContent](#model-GsaUpdateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118741,7 +86488,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterValue](#model-GsaUpdateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118776,32 +86523,34 @@ }, "additionalProperties": false }, - "GsaUpdateDisplayNames": { + "GsaUpdateDynamicRecordLinkGroup": { "type": "object", - "properties": { - "displayNames": { - "$ref": "#/components/schemas/GsaGrid" - } - }, - "additionalProperties": false - }, - "GsaUpdateDisplayNamesResponse": { - "required": [ - "numberDeleted", - "numberUpdated" - ], - "type": "object", - "properties": { - "numberUpdated": { - "type": "integer", - "format": "int32" + "allOf": [ + { + "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" }, - "numberDeleted": { - "type": "integer", - "format": "int32" + { + "type": "object", + "properties": { + "forbidOrphans": { + "type": "boolean" + }, + "referentialIntegrityModel": { + "$ref": "#/components/schemas/GsaReferentialIntegrityModel" + }, + "attributePairs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" + } + } + } } - }, - "additionalProperties": false + ], + "additionalProperties": false, + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'dynamic'", + "x-discriminator-value": "dynamic", + "x-discriminator-name": "type" }, "GsaUpdateExpression": { "type": "object", @@ -118850,7 +86599,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'file'", "x-discriminator-value": "file", "x-discriminator-name": "type" }, @@ -118879,7 +86628,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'floatFunctional'", "x-discriminator-value": "floatFunctional", "x-discriminator-name": "type" }, @@ -118899,7 +86648,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: [GsaUpdateFloatFunctionalAttributeParameter](#model-GsaUpdateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", + "description": "\r\n\r\ndefaultValue: If there is no default value, fallback to the parameter default.\r\n\r\nThis extends: GsaUpdateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'discrete'", "x-discriminator-value": "discrete", "x-discriminator-name": "type" }, @@ -118928,7 +86677,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: [GsaUpdateFloatFunctionalAttributeParameter](#model-GsaUpdateFloatFunctionalAttributeParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\ninterpolationMethod: If the InterpolationMethod is\r\n\r\nscaleType: If the ScaleType is\r\n\r\nThis extends: GsaUpdateFloatFunctionalAttributeParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -118948,7 +86697,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateFloatFunctionalAttributeDiscreteParameter](#model-GsaUpdateFloatFunctionalAttributeDiscreteParameter)\r\n * [GsaUpdateFloatFunctionalAttributeNumericParameter](#model-GsaUpdateFloatFunctionalAttributeNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateFloatFunctionalAttributeDiscreteParameter\r\n * GsaUpdateFloatFunctionalAttributeNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -118981,7 +86730,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'hyperlink'", "x-discriminator-value": "hyperlink", "x-discriminator-name": "type" }, @@ -119002,7 +86751,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'integer'", "x-discriminator-value": "integer", "x-discriminator-name": "type" }, @@ -119049,27 +86798,6 @@ }, "additionalProperties": false }, - "GsaUpdateLayoutSection": { - "type": "object", - "properties": { - "sectionItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - "description": "Update the set of items, in order.\r\nIf an existing item is not included, it will be deleted." - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false, - "description": "Update dto for Layout Sections" - }, "GsaUpdateLinkedAttributeTabularColumn": { "type": "object", "allOf": [ @@ -119086,7 +86814,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedAttribute'", "x-discriminator-value": "linkedAttribute", "x-discriminator-name": "columnType" }, @@ -119106,7 +86834,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedColumn'", "x-discriminator-value": "linkedColumn", "x-discriminator-name": "columnType" }, @@ -119121,7 +86849,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'linkedRecord'", "x-discriminator-value": "linkedRecord", "x-discriminator-name": "columnType" }, @@ -119141,7 +86869,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDateTime'", "x-discriminator-value": "localDateTime", "x-discriminator-name": "columnType" }, @@ -119164,7 +86892,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localDiscrete'", "x-discriminator-value": "localDiscrete", "x-discriminator-name": "columnType" }, @@ -119184,7 +86912,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localFile'", "x-discriminator-value": "localFile", "x-discriminator-name": "columnType" }, @@ -119204,7 +86932,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localHyperlink'", "x-discriminator-value": "localHyperlink", "x-discriminator-name": "columnType" }, @@ -119224,7 +86952,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localInteger'", "x-discriminator-value": "localInteger", "x-discriminator-name": "columnType" }, @@ -119244,7 +86972,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLogical'", "x-discriminator-value": "localLogical", "x-discriminator-name": "columnType" }, @@ -119264,7 +86992,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localLongText'", "x-discriminator-value": "localLongText", "x-discriminator-name": "columnType" }, @@ -119284,7 +87012,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPicture'", "x-discriminator-value": "localPicture", "x-discriminator-name": "columnType" }, @@ -119307,7 +87035,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localPoint'", "x-discriminator-value": "localPoint", "x-discriminator-name": "columnType" }, @@ -119330,7 +87058,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localRange'", "x-discriminator-value": "localRange", "x-discriminator-name": "columnType" }, @@ -119350,7 +87078,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'localShortText'", "x-discriminator-value": "localShortText", "x-discriminator-name": "columnType" }, @@ -119365,7 +87093,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'logical'", "x-discriminator-value": "logical", "x-discriminator-name": "type" }, @@ -119380,7 +87108,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'longText'", "x-discriminator-value": "longText", "x-discriminator-name": "type" }, @@ -119457,7 +87185,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'mathsFunctional'", "x-discriminator-value": "mathsFunctional", "x-discriminator-name": "type" }, @@ -119473,13 +87201,6 @@ "unit": { "$ref": "#/components/schemas/GsaSlimEntity" }, - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdateNumericParameterValue" - }, - "description": "Update the set of parameter values.\r\nThis can result in adding, modifying and deleting parameter values.\r\nNumeric parameter values can not be reordered - they are ordered by numeric value.\r\nExisting parameter values will be matched by GUID.\r\nIf an existing parameter value is not included, it will be deleted.\r\nIf a GUID is not provided, or the GUID does not match an existing value, a new value will be created.\r\nNew values must have a value." - }, "interpolationType": { "$ref": "#/components/schemas/GsaParameterInterpolationType" }, @@ -119490,7 +87211,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameter](#model-GsaUpdateParameter)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameter\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -119515,7 +87236,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterContent](#model-GsaUpdateParameterContent)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterContent\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -119540,7 +87261,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateParameterValue](#model-GsaUpdateParameterValue)\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", + "description": "\r\n\r\nThis extends: GsaUpdateParameterValue\r\n\r\nThe value of discriminator property ('type') must be equal to 'numeric'", "x-discriminator-value": "numeric", "x-discriminator-name": "type" }, @@ -119553,16 +87274,14 @@ "type": { "$ref": "#/components/schemas/GsaParameterType" }, + "helpPath": { + "type": "string", + "nullable": true + }, "defaultParameterValueGuid": { "type": "string", - "description": "Use to set the default value when the parameter value GUID is known.", "format": "uuid" }, - "defaultParameterValueIndex": { - "type": "integer", - "description": "Use to set the default value when also updating parameter values, if the parameter value GUID is not known.\r\nFor example when creating a new parameter value.", - "format": "int32" - }, "name": { "type": "string" }, @@ -119572,7 +87291,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameter](#model-GsaUpdateDiscreteParameter)\r\n * [GsaUpdateNumericParameter](#model-GsaUpdateNumericParameter)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameter\r\n * GsaUpdateNumericParameter", "discriminator": { "propertyName": "type", "mapping": { @@ -119596,7 +87315,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameterContent](#model-GsaUpdateDiscreteParameterContent)\r\n * [GsaUpdateNumericParameterContent](#model-GsaUpdateNumericParameterContent)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameterContent\r\n * GsaUpdateNumericParameterContent", "discriminator": { "propertyName": "type", "mapping": { @@ -119620,7 +87339,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateDiscreteParameterValue](#model-GsaUpdateDiscreteParameterValue)\r\n * [GsaUpdateNumericParameterValue](#model-GsaUpdateNumericParameterValue)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateDiscreteParameterValue\r\n * GsaUpdateNumericParameterValue", "discriminator": { "propertyName": "type", "mapping": { @@ -119629,123 +87348,6 @@ } } }, - "GsaUpdatePermission": { - "type": "object", - "properties": { - "role": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionAccessControl": { - "required": [ - "permission" - ], - "type": "object", - "properties": { - "permission": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "canRead": { - "type": "boolean" - }, - "canWrite": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionBasedAccessControl": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateAccessControl" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAccessControl](#model-GsaUpdateAccessControl)\r\n\r\nThe value of discriminator property ('mode') must be equal to 'permissionBased'", - "x-discriminator-value": "permissionBased", - "x-discriminator-name": "mode" - }, - "GsaUpdatePermissionCategory": { - "type": "object", - "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermission" - }, - "description": "This can result in adding, modifying and deleting permissions.\r\nTo insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission).\r\nTo modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission).\r\nExisting permissions will be matched by GUID.\r\nIf an existing permission is not included, it will be deleted." - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionCategoryAccessControl": { - "required": [ - "category", - "permissionAccessControls" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/GsaSlimEntity" - }, - "permissionAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdatePermissionAccessControl" - } - } - }, - "additionalProperties": false - }, - "GsaUpdatePermissionCategoryAccessControlRequest": { - "required": [ - "categoryAccessControls" - ], - "type": "object", - "properties": { - "categoryAccessControls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUpdatePermissionCategoryAccessControl" - } - } - }, - "additionalProperties": false - }, "GsaUpdatePictureAttribute": { "type": "object", "allOf": [ @@ -119757,7 +87359,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'picture'", "x-discriminator-value": "picture", "x-discriminator-name": "type" }, @@ -119787,7 +87389,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'point'", "x-discriminator-value": "point", "x-discriminator-name": "type" }, @@ -119848,109 +87450,6 @@ "additionalProperties": false, "description": "A table within a profile. Contains display customization." }, - "GsaUpdatePutLayoutItem": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutLayoutItem" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaPutLayoutItem](#model-GsaPutLayoutItem)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, - "GsaUpdatePutPermission": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermission" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - }, - "description": { - "type": "string", - "description": "The description of the permission.", - "nullable": true - }, - "setMessage": { - "type": "string", - "description": "Message to show when this permission is set.", - "nullable": true - }, - "unsetMessage": { - "type": "string", - "description": "Message to show when this permission is not set.", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Update a Permission.\r\nThe Guid should match the Guid of the existing Permission to update.\r\n\r\nThis extends: [GsaPutPermission](#model-GsaPutPermission)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, - "GsaUpdatePutPermissionCategory": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaPutPermissionCategory" - }, - { - "required": [ - "guid" - ], - "type": "object", - "properties": { - "guid": { - "type": "string", - "format": "uuid" - }, - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaPutPermission" - }, - "description": "This can result in adding, modifying and deleting permissions.\r\nTo insert a new permission, use a [GsaCreatePutPermission](#model-GsaCreatePutPermission).\r\nTo modify an existing permission, use a [GsaUpdatePutPermission](#model-GsaUpdatePutPermission).\r\nExisting permissions will be matched by GUID.\r\nIf an existing permission is not included, it will be deleted." - } - } - } - ], - "additionalProperties": false, - "description": "Update a Permission Category.\r\nThe Guid should match the Guid of the existing Permission Category to update.\r\n\r\nThis extends: [GsaPutPermissionCategory](#model-GsaPutPermissionCategory)\r\n\r\nThe value of discriminator property ('type') must be equal to 'update'", - "x-discriminator-value": "update", - "x-discriminator-name": "type" - }, "GsaUpdateRangeAttribute": { "type": "object", "allOf": [ @@ -119967,7 +87466,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'range'", "x-discriminator-value": "range", "x-discriminator-name": "type" }, @@ -119992,12 +87491,12 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaUpdateStaticRecordLinkGroup](#model-GsaUpdateStaticRecordLinkGroup)\r\n * [GsaUpdateSmartRecordLinkGroup](#model-GsaUpdateSmartRecordLinkGroup)\r\n * [GsaUpdateCrossDatabaseRecordLinkGroup](#model-GsaUpdateCrossDatabaseRecordLinkGroup)", + "description": "\r\n\r\nThis is one of: \r\n * GsaUpdateStaticRecordLinkGroup\r\n * GsaUpdateDynamicRecordLinkGroup\r\n * GsaUpdateCrossDatabaseRecordLinkGroup", "discriminator": { "propertyName": "type", "mapping": { "static": "#/components/schemas/GsaUpdateStaticRecordLinkGroup", - "smart": "#/components/schemas/GsaUpdateSmartRecordLinkGroup", + "dynamic": "#/components/schemas/GsaUpdateDynamicRecordLinkGroup", "crossDatabase": "#/components/schemas/GsaUpdateCrossDatabaseRecordLinkGroup" } } @@ -120073,43 +87572,6 @@ }, "additionalProperties": false }, - "GsaUpdateRootFolderErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaFolderErrorDetail" - }, - { - "type": "object" - } - ], - "additionalProperties": false, - "description": "You cannot update the root folder.\r\n\r\nThis extends: [GsaFolderErrorDetail](#model-GsaFolderErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'updateRoot'", - "x-discriminator-value": "updateRoot", - "x-discriminator-name": "reason" - }, - "GsaUpdateRunStatus": { - "enum": [ - "Registered", - "UploadInProgress", - "Uploaded", - "UploadFailed", - "DryRunPending", - "DryRunCancelling", - "DryRunCancelled", - "DryRunInProgress", - "DryRunComplete", - "DryRunFailed", - "ApplyPending", - "ApplyInProgress", - "ApplyCancelling", - "ApplyCancelled", - "ApplyComplete", - "ApplyFailed" - ], - "type": "string", - "description": "Represents the possible states of an update.

Possible values:

\r\n
    \r\n
  • Registered: The update token has been registered with the service.
    • \r\n
  • UploadInProgress: The update file has been partially uploaded.
    • \r\n
  • Uploaded: The update file has been completely uploaded.
    • \r\n
  • UploadFailed: The upload failed.
    • \r\n
  • DryRunPending: A dry run for this update has been queued, but it not yet in progress.
    • \r\n
  • DryRunCancelling: A request to cancel the dry run for this update has been issued but the dry run has not yet been cancelled.
    • \r\n
  • DryRunCancelled: The dry run for this update was cancelled.
    • \r\n
  • DryRunInProgress: The dry run for this update is in progress.
    • \r\n
  • DryRunComplete: The dry run for this update is complete.
    • \r\n
  • DryRunFailed: The dry run for this update failed.
    • \r\n
  • ApplyPending: An apply operation for this update has been queued, but is not yet in progress.
    • \r\n
  • ApplyInProgress: The update is being applied to the target database.
    • \r\n
  • ApplyCancelling: A request to cancel the apply process has been issued but the apply process has not yet been cancelled.
    • \r\n
  • ApplyCancelled: The update was cancelled during the apply process.
    • \r\n
  • ApplyComplete: The update was successfully applied to the target database.
    • \r\n
  • ApplyFailed: The update was not successfully applied to the target database.
    • \r\n
\r\n" - }, "GsaUpdateShortTextAttribute": { "type": "object", "allOf": [ @@ -120130,40 +87592,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", + "description": "\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'shortText'", "x-discriminator-value": "shortText", "x-discriminator-name": "type" }, - "GsaUpdateSmartRecordLinkGroup": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaUpdateRecordLinkGroup" - }, - { - "type": "object", - "properties": { - "forbidOrphans": { - "type": "boolean" - }, - "referentialIntegrityModel": { - "$ref": "#/components/schemas/GsaReferentialIntegrityModel" - }, - "attributePairs": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaCreateAttributeLinkPair" - }, - "description": "The attribute pairs cannot be updated other than by creating a new set.\r\nThere must be at least one and not more than three attribute pairs." - } - } - } - ], - "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'smart'", - "x-discriminator-value": "smart", - "x-discriminator-name": "type" - }, "GsaUpdateStandardName": { "type": "object", "properties": { @@ -120221,7 +87653,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateRecordLinkGroup](#model-GsaUpdateRecordLinkGroup)\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", + "description": "\r\n\r\nThis extends: GsaUpdateRecordLinkGroup\r\n\r\nThe value of discriminator property ('type') must be equal to 'static'", "x-discriminator-value": "static", "x-discriminator-name": "type" }, @@ -120260,34 +87692,6 @@ "format": "uuid", "nullable": true }, - "qualitySystemGuid": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "legalDisclaimer": { - "type": "string", - "nullable": true - }, - "datasheetHeader": { - "type": "string", - "nullable": true - }, - "datasheetFooter": { - "type": "string", - "nullable": true - }, - "tableTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "If specified any existing table types are replaced.", - "nullable": true - }, - "shouldShowVersionControlSignatures": { - "type": "boolean" - }, "name": { "type": "string" }, @@ -120330,7 +87734,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\ntarget: Changing an existing target may cause some columns to become unavailable.\r\n\r\nThis extends: [GsaUpdateAttribute](#model-GsaUpdateAttribute)\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", + "description": "\r\n\r\ntarget: Changing an existing target may cause some columns to become unavailable.\r\n\r\nThis extends: GsaUpdateAttribute\r\n\r\nThe value of discriminator property ('type') must be equal to 'link'", "x-discriminator-value": "link", "x-discriminator-name": "type" }, @@ -120390,7 +87794,7 @@ } }, "additionalProperties": false, - "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * [GsaUpdateLinkedAttributeTabularColumn](#model-GsaUpdateLinkedAttributeTabularColumn)\r\n * [GsaUpdateLinkedColumnTabularColumn](#model-GsaUpdateLinkedColumnTabularColumn)\r\n * [GsaUpdateLinkedRecordTabularColumn](#model-GsaUpdateLinkedRecordTabularColumn)\r\n * [GsaUpdateLocalPointTabularColumn](#model-GsaUpdateLocalPointTabularColumn)\r\n * [GsaUpdateLocalRangeTabularColumn](#model-GsaUpdateLocalRangeTabularColumn)\r\n * [GsaUpdateLocalIntegerTabularColumn](#model-GsaUpdateLocalIntegerTabularColumn)\r\n * [GsaUpdateLocalLogicalTabularColumn](#model-GsaUpdateLocalLogicalTabularColumn)\r\n * [GsaUpdateLocalShortTextTabularColumn](#model-GsaUpdateLocalShortTextTabularColumn)\r\n * [GsaUpdateLocalLongTextTabularColumn](#model-GsaUpdateLocalLongTextTabularColumn)\r\n * [GsaUpdateLocalDateTimeTabularColumn](#model-GsaUpdateLocalDateTimeTabularColumn)\r\n * [GsaUpdateLocalDiscreteTabularColumn](#model-GsaUpdateLocalDiscreteTabularColumn)\r\n * [GsaUpdateLocalHyperlinkTabularColumn](#model-GsaUpdateLocalHyperlinkTabularColumn)\r\n * [GsaUpdateLocalFileTabularColumn](#model-GsaUpdateLocalFileTabularColumn)\r\n * [GsaUpdateLocalPictureTabularColumn](#model-GsaUpdateLocalPictureTabularColumn)\r\n * [GsaUpdateUnavailableTabularColumn](#model-GsaUpdateUnavailableTabularColumn)", + "description": "Possible values for RollUpType depends on the underlying data type of the column:\r\n \r\n- FloatFunctional: Chart, Count\r\n \r\n- Numeric types (Integer, Point, Range): Count, CountDistinct, List, ListDistinct, Max, Min, Mean, StdDev, Sum, CoefficientOfVariation\r\n \r\n- Other types: Count, CountDistinct, List, ListDistinct\r\n - DateTime, Logical, and ordered Discrete also include Min and Max.\r\n\r\nThis is one of: \r\n * GsaUpdateLinkedAttributeTabularColumn\r\n * GsaUpdateLinkedColumnTabularColumn\r\n * GsaUpdateLinkedRecordTabularColumn\r\n * GsaUpdateLocalPointTabularColumn\r\n * GsaUpdateLocalRangeTabularColumn\r\n * GsaUpdateLocalIntegerTabularColumn\r\n * GsaUpdateLocalLogicalTabularColumn\r\n * GsaUpdateLocalShortTextTabularColumn\r\n * GsaUpdateLocalLongTextTabularColumn\r\n * GsaUpdateLocalDateTimeTabularColumn\r\n * GsaUpdateLocalDiscreteTabularColumn\r\n * GsaUpdateLocalHyperlinkTabularColumn\r\n * GsaUpdateLocalFileTabularColumn\r\n * GsaUpdateLocalPictureTabularColumn\r\n * GsaUpdateUnavailableTabularColumn", "discriminator": { "propertyName": "columnType", "mapping": { @@ -120423,7 +87827,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUpdateTabularColumn](#model-GsaUpdateTabularColumn)\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", + "description": "\r\n\r\nThis extends: GsaUpdateTabularColumn\r\n\r\nThe value of discriminator property ('columnType') must be equal to 'unavailable'", "x-discriminator-value": "unavailable", "x-discriminator-name": "columnType" }, @@ -120494,44 +87898,6 @@ }, "additionalProperties": false }, - "GsaUpgradeDatabaseException": { - "required": [ - "upgradeDatabaseFailureReason" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "code": { - "$ref": "#/components/schemas/GsaErrorCode" - }, - "upgradeDatabaseFailureReason": { - "$ref": "#/components/schemas/GsaUpgradeDatabaseFailureReason" - }, - "additionalInformation": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaErrorDetail" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "GsaUpgradeDatabaseFailureReason": { - "enum": [ - "unableToConnect", - "insufficientPermissions", - "unknownError" - ], - "type": "string" - }, "GsaUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -120553,30 +87919,41 @@ "mapping": { "expression": "#/components/schemas/GsaExpressionUsageDataModificationErrorDetail", "versionControlledData": "#/components/schemas/GsaVersionControlledDataUsageDataModificationErrorDetail", - "smartLinkGroup": "#/components/schemas/GsaSmartLinkGroupUsageDataModificationErrorDetail", + "dynamicLinkGroup": "#/components/schemas/GsaDynamicLinkGroupUsageDataModificationErrorDetail", "tabularAttribute": "#/components/schemas/GsaTabularAttributeUsageDataModificationErrorDetail", "xyChartTemplate": "#/components/schemas/GsaXYChartTemplateUsageDataModificationErrorDetail", "searchMask": "#/components/schemas/GsaSearchMaskUsageDataModificationErrorDetail", "securityAttribute": "#/components/schemas/GsaSecurityAttributeUsageDataModificationErrorDetail", "attribute": "#/components/schemas/GsaAttributeUsageDataModificationErrorDetail", "data": "#/components/schemas/GsaDataUsageDataModificationErrorDetail", - "defaultParameterValue": "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail", - "functionalDataDefault": "#/components/schemas/GsaFunctionalDataDefaultUsageDataModificationErrorDetail", - "multiValuedPointData": "#/components/schemas/GsaMultiValuedPointDataUsageDataModificationErrorDetail", - "tabularColumn": "#/components/schemas/GsaTabularColumnUsageDataModificationErrorDetail", - "databaseCurrencyUnit": "#/components/schemas/GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail", - "unit": "#/components/schemas/GsaUnitUsageDataModificationErrorDetail", - "parameter": "#/components/schemas/GsaParameterUsageDataModificationErrorDetail", - "constant": "#/components/schemas/GsaConstantUsageDataModificationErrorDetail" + "defaultParameterValue": "#/components/schemas/GsaDefaultParameterValueUsageDataModificationErrorDetail" } } } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaDataModificationErrorDetail](#model-GsaDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'usage'\r\n\r\nThis is one of: \r\n * [GsaExpressionUsageDataModificationErrorDetail](#model-GsaExpressionUsageDataModificationErrorDetail)\r\n * [GsaVersionControlledDataUsageDataModificationErrorDetail](#model-GsaVersionControlledDataUsageDataModificationErrorDetail)\r\n * [GsaSmartLinkGroupUsageDataModificationErrorDetail](#model-GsaSmartLinkGroupUsageDataModificationErrorDetail)\r\n * [GsaTabularAttributeUsageDataModificationErrorDetail](#model-GsaTabularAttributeUsageDataModificationErrorDetail)\r\n * [GsaXYChartTemplateUsageDataModificationErrorDetail](#model-GsaXYChartTemplateUsageDataModificationErrorDetail)\r\n * [GsaSearchMaskUsageDataModificationErrorDetail](#model-GsaSearchMaskUsageDataModificationErrorDetail)\r\n * [GsaSecurityAttributeUsageDataModificationErrorDetail](#model-GsaSecurityAttributeUsageDataModificationErrorDetail)\r\n * [GsaAttributeUsageDataModificationErrorDetail](#model-GsaAttributeUsageDataModificationErrorDetail)\r\n * [GsaDataUsageDataModificationErrorDetail](#model-GsaDataUsageDataModificationErrorDetail)\r\n * [GsaDefaultParameterValueUsageDataModificationErrorDetail](#model-GsaDefaultParameterValueUsageDataModificationErrorDetail)\r\n * [GsaFunctionalDataDefaultUsageDataModificationErrorDetail](#model-GsaFunctionalDataDefaultUsageDataModificationErrorDetail)\r\n * [GsaMultiValuedPointDataUsageDataModificationErrorDetail](#model-GsaMultiValuedPointDataUsageDataModificationErrorDetail)\r\n * [GsaTabularColumnUsageDataModificationErrorDetail](#model-GsaTabularColumnUsageDataModificationErrorDetail)\r\n * [GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail](#model-GsaDatabaseCurrencyUnitUsageDataModificationErrorDetail)\r\n * [GsaUnitUsageDataModificationErrorDetail](#model-GsaUnitUsageDataModificationErrorDetail)\r\n * [GsaParameterUsageDataModificationErrorDetail](#model-GsaParameterUsageDataModificationErrorDetail)\r\n * [GsaConstantUsageDataModificationErrorDetail](#model-GsaConstantUsageDataModificationErrorDetail)", + "description": "\r\n\r\nThis extends: GsaDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('reason') must be equal to 'usage'\r\n\r\nThis is one of: \r\n * GsaExpressionUsageDataModificationErrorDetail\r\n * GsaVersionControlledDataUsageDataModificationErrorDetail\r\n * GsaDynamicLinkGroupUsageDataModificationErrorDetail\r\n * GsaTabularAttributeUsageDataModificationErrorDetail\r\n * GsaXYChartTemplateUsageDataModificationErrorDetail\r\n * GsaSearchMaskUsageDataModificationErrorDetail\r\n * GsaSecurityAttributeUsageDataModificationErrorDetail\r\n * GsaAttributeUsageDataModificationErrorDetail\r\n * GsaDataUsageDataModificationErrorDetail\r\n * GsaDefaultParameterValueUsageDataModificationErrorDetail", "x-discriminator-value": "usage", "x-discriminator-name": "reason" }, + "GsaUserOrGroup": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "format": "uuid" + }, + "displayName": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, "GsaUserPermission": { "required": [ "flags", @@ -120645,64 +88022,6 @@ }, "additionalProperties": false }, - "GsaValidateUnitEquationRequest": { - "required": [ - "equation" - ], - "type": "object", - "properties": { - "equation": { - "type": "string", - "description": "The equation to check" - } - }, - "additionalProperties": false - }, - "GsaValidateUnitEquationResponse": { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "isValid": { - "type": "boolean" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaUnitEquationErrorDetail" - }, - "description": "Details of any errors found in the equation." - } - }, - "additionalProperties": false - }, - "GsaValueNotProvidedParameterValueErrorDetail": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GsaParameterValueErrorDetail" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "guid": { - "type": "string", - "format": "uuid", - "nullable": true - } - } - } - ], - "additionalProperties": false, - "description": "Numeric parameter values must have a value.\r\n\r\nThis extends: [GsaParameterValueErrorDetail](#model-GsaParameterValueErrorDetail)\r\n\r\nThe value of discriminator property ('reason') must be equal to 'valueNotProvided'", - "x-discriminator-value": "valueNotProvided", - "x-discriminator-name": "reason" - }, "GsaValueSpecifier": { "required": [ "filterOn" @@ -120714,7 +88033,7 @@ } }, "additionalProperties": false, - "description": "Base class for ValueSpecifier\r\nUsed as a parameter in requests to specify filters like whether we want all identities, some guids, exclude some identities, etc.\r\n\r\nThis is one of: \r\n * [GsaAllValuesSpecifier](#model-GsaAllValuesSpecifier)\r\n * [GsaExcludeValuesSpecifier](#model-GsaExcludeValuesSpecifier)\r\n * [GsaSpecificValuesSpecifier](#model-GsaSpecificValuesSpecifier)\r\n * [GsaNoValuesSpecifier](#model-GsaNoValuesSpecifier)", + "description": "Base class for ValueSpecifier\r\nUsed as a parameter in requests to specify filters like whether we want all identities, some guids, exclude some identities, etc.\r\n\r\nThis is one of: \r\n * GsaAllValuesSpecifier\r\n * GsaExcludeValuesSpecifier\r\n * GsaSpecificValuesSpecifier\r\n * GsaNoValuesSpecifier", "discriminator": { "propertyName": "filterOn", "mapping": { @@ -120794,7 +88113,7 @@ } }, "additionalProperties": false, - "description": "\r\n\r\nThis is one of: \r\n * [GsaInvalidVersionStateErrorDetail](#model-GsaInvalidVersionStateErrorDetail)\r\n * [GsaNotTheLatestVersionErrorDetail](#model-GsaNotTheLatestVersionErrorDetail)\r\n * [GsaInvalidParentStateErrorDetail](#model-GsaInvalidParentStateErrorDetail)\r\n * [GsaNotVersionedErrorDetail](#model-GsaNotVersionedErrorDetail)", + "description": "\r\n\r\nThis is one of: \r\n * GsaInvalidVersionStateErrorDetail\r\n * GsaNotTheLatestVersionErrorDetail\r\n * GsaInvalidParentStateErrorDetail\r\n * GsaNotVersionedErrorDetail", "discriminator": { "propertyName": "reason", "mapping": { @@ -120816,7 +88135,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'versionControlledData'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'versionControlledData'", "x-discriminator-value": "versionControlledData", "x-discriminator-name": "referencedByType" }, @@ -120837,7 +88156,7 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionNumber'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionNumber'", "x-discriminator-value": "versionNumber", "x-discriminator-name": "propertyName" }, @@ -120868,19 +88187,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaProperty](#model-GsaProperty)\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionState'", + "description": "\r\n\r\nThis extends: GsaProperty\r\n\r\nThe value of discriminator property ('propertyName') must be equal to 'versionState'", "x-discriminator-value": "versionState", "x-discriminator-name": "propertyName" }, - "GsaWeightingType": { - "enum": [ - 0, - 1, - 2 - ], - "type": "integer", - "format": "int32" - }, "GsaWithdrawRecordVersionControlException": { "type": "object", "properties": { @@ -120889,7 +88199,7 @@ "nullable": true }, "code": { - "$ref": "#/components/schemas/GsaErrorCode" + "$ref": "#/components/schemas/SystemNetHttpStatusCode" }, "errors": { "type": "array", @@ -120901,50 +88211,6 @@ }, "additionalProperties": false }, - "GsaXYChartTemplate": { - "required": [ - "displayNames", - "guid", - "name" - ], - "type": "object", - "properties": { - "chartTitle": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "tableGuid": { - "type": "string", - "format": "uuid" - }, - "xAxis": { - "$ref": "#/components/schemas/GsaXYTemplateAxis" - }, - "yAxis": { - "$ref": "#/components/schemas/GsaXYTemplateAxis" - }, - "displayNames": { - "type": "object", - "additionalProperties": { - "type": "string", - "nullable": true - }, - "description": "A dictionary of the culture name to the name that should be used in that culture for the item" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "GsaXYChartTemplateUsageDataModificationErrorDetail": { "type": "object", "allOf": [ @@ -120965,66 +88231,10 @@ } ], "additionalProperties": false, - "description": "\r\n\r\nThis extends: [GsaUsageDataModificationErrorDetail](#model-GsaUsageDataModificationErrorDetail)\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'xyChartTemplate'", + "description": "\r\n\r\nThis extends: GsaUsageDataModificationErrorDetail\r\n\r\nThe value of discriminator property ('referencedByType') must be equal to 'xyChartTemplate'", "x-discriminator-value": "xyChartTemplate", "x-discriminator-name": "referencedByType" }, - "GsaXYChartTemplatesInfo": { - "required": [ - "entries", - "itemType", - "links" - ], - "type": "object", - "properties": { - "itemType": { - "$ref": "#/components/schemas/GsaPaginatedItemType" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GsaXYChartTemplate" - } - }, - "links": { - "$ref": "#/components/schemas/GsaPaginationLinks" - } - }, - "additionalProperties": false - }, - "GsaXYTemplateAxis": { - "required": [ - "guid", - "name" - ], - "type": "object", - "properties": { - "attributeGuid": { - "type": "string", - "format": "uuid" - }, - "logarithmic": { - "type": "boolean" - }, - "bounds": { - "$ref": "#/components/schemas/GsaDataExportRange" - }, - "attributeUnit": { - "$ref": "#/components/schemas/GsaUnit" - }, - "autoScale": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "guid": { - "type": "string", - "format": "uuid" - } - }, - "additionalProperties": false - }, "JsonPatchDocument": { "type": "object", "properties": {